---
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

### registeredEvents()

Returns a `Set<string>` of every event name a composer has handlers for — collected from `.on()` and event-specific `.derive()` middleware entries. Composite events (`"message|callback_query"`) are split, and entity patterns (`"message:text"`) are kept as-is.

```ts
const app = new Composer()
    .on("message", h1)
    .on(["callback_query", "inline_query"], h2)
    .derive("chat_member", h3);

app.registeredEvents();
// → Set { "message", "callback_query", "inline_query", "chat_member" }
```

This powers gramio 0.9's auto-derived `allowed_updates` — `bot.start()` runs `registeredEvents()` over the whole composer tree to figure out which Telegram update types you actually use.

## 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:514

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

***

### skip

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

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

Pass-through middleware: calls next() immediately

***

### stop

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

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

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:511

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:491

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:497 |
| `Composer` | [`EventComposerConstructor`](interfaces/EventComposerConstructor.md)<`TBase`, `TEventMap`, `TMethods`> | composer/index.d.ts:496 |
| `EventQueue` | *typeof* [`EventQueue`](classes/EventQueue.md) | composer/index.d.ts:498 |

***

### defineComposerMethods()

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

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

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:487

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. |
| [ManagedBotContext](classes/ManagedBotContext.md) | This object represents a new bot created to be managed by the current bot, or a bot whose token was changed. |
| [ManagedBotCreated](classes/ManagedBotCreated.md) | This object contains information about the bot that was created to be managed by the current bot. |
| [ManagedBotCreatedContext](classes/ManagedBotCreatedContext.md) | This object represents a service message about a user creating a bot that will be managed by the current bot. |
| [ManagedBotUpdated](classes/ManagedBotUpdated.md) | This object contains information about the creation or token update of a bot that is managed by the current bot. |
| [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. |
| [PollOptionAdded](classes/PollOptionAdded.md) | Describes a service message about an option added to a poll. |
| [PollOptionAddedContext](classes/PollOptionAddedContext.md) | This object represents a service message about an option added to a poll. |
| [PollOptionDeleted](classes/PollOptionDeleted.md) | Describes a service message about an option deleted from a poll. |
| [PollOptionDeletedContext](classes/PollOptionDeletedContext.md) | This object represents a service message about an option deleted from 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) | - |
| [IsAny](type-aliases/IsAny.md) | Helper to detect if a type is 'any' |
| [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:6932

Helper for construct mixins

#### Parameters

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

#### Returns

`void`

***

### backgroundFillMap

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

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

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:1065 |
|  `gradient` | *typeof* [`BackgroundFillGradient`](classes/BackgroundFillGradient.md) | contexts/index.d.ts:1064 |
|  `solid` | *typeof* [`BackgroundFillSolid`](classes/BackgroundFillSolid.md) | contexts/index.d.ts:1063 |

***

### backgroundTypeMap

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

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

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:1194 |
|  `fill` | *typeof* [`BackgroundTypeFill`](classes/BackgroundTypeFill.md) | contexts/index.d.ts:1191 |
|  `pattern` | *typeof* [`BackgroundTypePattern`](classes/BackgroundTypePattern.md) | contexts/index.d.ts:1193 |
|  `wallpaper` | *typeof* [`BackgroundTypeWallpaper`](classes/BackgroundTypeWallpaper.md) | contexts/index.d.ts:1192 |

***

### contextsMappings

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

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

Mapping UpdateNames to their contexts

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
|  `boost_added` | *typeof* [`BoostAddedContext`](classes/BoostAddedContext.md) | contexts/index.d.ts:6996 |
|  `business_connection` | *typeof* [`BusinessConnectionContext`](classes/BusinessConnectionContext.md) | contexts/index.d.ts:6981 |
|  `business_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6978 |
|  `callback_query` | *typeof* [`CallbackQueryContext`](classes/CallbackQueryContext.md) | contexts/index.d.ts:6960 |
|  `channel_post` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6975 |
|  `chat_background_set` | *typeof* [`ChatBackgroundSetContext`](classes/ChatBackgroundSetContext.md) | contexts/index.d.ts:6997 |
|  `chat_boost` | *typeof* [`ChatBoostContext`](classes/ChatBoostContext.md) | contexts/index.d.ts:7032 |
|  `chat_join_request` | *typeof* [`ChatJoinRequestContext`](classes/ChatJoinRequestContext.md) | contexts/index.d.ts:6961 |
|  `chat_member` | *typeof* [`ChatMemberContext`](classes/ChatMemberContext.md) | contexts/index.d.ts:6962 |
|  `chat_owner_changed` | *typeof* [`ChatOwnerChangedContext`](classes/ChatOwnerChangedContext.md) | contexts/index.d.ts:7021 |
|  `chat_owner_left` | *typeof* [`ChatOwnerLeftContext`](classes/ChatOwnerLeftContext.md) | contexts/index.d.ts:7020 |
|  `chat_shared` | *typeof* [`ChatSharedContext`](classes/ChatSharedContext.md) | contexts/index.d.ts:7016 |
|  `checklist_tasks_added` | *typeof* [`ChecklistTasksAddedContext`](classes/ChecklistTasksAddedContext.md) | contexts/index.d.ts:6999 |
|  `checklist_tasks_done` | *typeof* [`ChecklistTasksDoneContext`](classes/ChecklistTasksDoneContext.md) | contexts/index.d.ts:6998 |
|  `chosen_inline_result` | *typeof* [`ChosenInlineResultContext`](classes/ChosenInlineResultContext.md) | contexts/index.d.ts:6964 |
|  `delete_chat_photo` | *typeof* [`DeleteChatPhotoContext`](classes/DeleteChatPhotoContext.md) | contexts/index.d.ts:6965 |
|  `deleted_business_messages` | *typeof* [`BusinessMessagesDeletedContext`](classes/BusinessMessagesDeletedContext.md) | contexts/index.d.ts:6980 |
|  `direct_message_price_changed` | *typeof* [`DirectMessagePriceChangedContext`](classes/DirectMessagePriceChangedContext.md) | contexts/index.d.ts:7000 |
|  `edited_business_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6979 |
|  `edited_channel_post` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6977 |
|  `edited_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6976 |
|  `forum_topic_closed` | *typeof* [`ForumTopicClosedContext`](classes/ForumTopicClosedContext.md) | contexts/index.d.ts:7008 |
|  `forum_topic_created` | *typeof* [`ForumTopicCreatedContext`](classes/ForumTopicCreatedContext.md) | contexts/index.d.ts:7006 |
|  `forum_topic_edited` | *typeof* [`ForumTopicEditedContext`](classes/ForumTopicEditedContext.md) | contexts/index.d.ts:7007 |
|  `forum_topic_reopened` | *typeof* [`ForumTopicReopenedContext`](classes/ForumTopicReopenedContext.md) | contexts/index.d.ts:7009 |
|  `general_forum_topic_hidden` | *typeof* [`GeneralForumTopicHiddenContext`](classes/GeneralForumTopicHiddenContext.md) | contexts/index.d.ts:7010 |
|  `general_forum_topic_unhidden` | *typeof* [`GeneralForumTopicUnhiddenContext`](classes/GeneralForumTopicUnhiddenContext.md) | contexts/index.d.ts:7011 |
|  `gift` | *typeof* [`GiftContext`](classes/GiftContext.md) | contexts/index.d.ts:7017 |
|  `gift_upgrade_sent` | *typeof* [`GiftUpgradeSentContext`](classes/GiftUpgradeSentContext.md) | contexts/index.d.ts:7018 |
|  `giveaway_completed` | *typeof* [`GiveawayCompletedContext`](classes/GiveawayCompletedContext.md) | contexts/index.d.ts:7035 |
|  `giveaway_created` | *typeof* [`GiveawayCreatedContext`](classes/GiveawayCreatedContext.md) | contexts/index.d.ts:7034 |
|  `giveaway_winners` | *typeof* [`GiveawayWinnersContext`](classes/GiveawayWinnersContext.md) | contexts/index.d.ts:7036 |
|  `group_chat_created` | *typeof* [`GroupChatCreatedContext`](classes/GroupChatCreatedContext.md) | contexts/index.d.ts:6966 |
|  `inline_query` | *typeof* [`InlineQueryContext`](classes/InlineQueryContext.md) | contexts/index.d.ts:6967 |
|  `invoice` | *typeof* [`InvoiceContext`](classes/InvoiceContext.md) | contexts/index.d.ts:6968 |
|  `left_chat_member` | *typeof* [`LeftChatMemberContext`](classes/LeftChatMemberContext.md) | contexts/index.d.ts:6969 |
|  `location` | *typeof* [`LocationContext`](classes/LocationContext.md) | contexts/index.d.ts:6970 |
|  `managed_bot` | *typeof* [`ManagedBotContext`](classes/ManagedBotContext.md) | contexts/index.d.ts:6971 |
|  `managed_bot_created` | *typeof* [`ManagedBotCreatedContext`](classes/ManagedBotCreatedContext.md) | contexts/index.d.ts:6972 |
|  `message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:6974 |
|  `message_auto_delete_timer_changed` | *typeof* [`MessageAutoDeleteTimerChangedContext`](classes/MessageAutoDeleteTimerChangedContext.md) | contexts/index.d.ts:6973 |
|  `message_reaction` | *typeof* [`MessageReactionContext`](classes/MessageReactionContext.md) | contexts/index.d.ts:7030 |
|  `message_reaction_count` | *typeof* [`MessageReactionCountContext`](classes/MessageReactionCountContext.md) | contexts/index.d.ts:7031 |
|  `migrate_from_chat_id` | *typeof* [`MigrateFromChatIdContext`](classes/MigrateFromChatIdContext.md) | contexts/index.d.ts:6982 |
|  `migrate_to_chat_id` | *typeof* [`MigrateToChatIdContext`](classes/MigrateToChatIdContext.md) | contexts/index.d.ts:6983 |
|  `my_chat_member` | *typeof* [`ChatMemberContext`](classes/ChatMemberContext.md) | contexts/index.d.ts:6963 |
|  `new_chat_members` | *typeof* [`NewChatMembersContext`](classes/NewChatMembersContext.md) | contexts/index.d.ts:6984 |
|  `new_chat_photo` | *typeof* [`NewChatPhotoContext`](classes/NewChatPhotoContext.md) | contexts/index.d.ts:6985 |
|  `new_chat_title` | *typeof* [`NewChatTitleContext`](classes/NewChatTitleContext.md) | contexts/index.d.ts:6986 |
|  `paid_message_price_changed` | *typeof* [`PaidMessagePriceChangedContext`](classes/PaidMessagePriceChangedContext.md) | contexts/index.d.ts:7022 |
|  `passport_data` | *typeof* [`PassportDataContext`](classes/PassportDataContext.md) | contexts/index.d.ts:6987 |
|  `pinned_message` | *typeof* [`PinnedMessageContext`](classes/PinnedMessageContext.md) | contexts/index.d.ts:6988 |
|  `poll` | *typeof* [`PollContext`](classes/PollContext.md) | contexts/index.d.ts:6992 |
|  `poll_answer` | *typeof* [`PollAnswerContext`](classes/PollAnswerContext.md) | contexts/index.d.ts:6989 |
|  `poll_option_added` | *typeof* [`PollOptionAddedContext`](classes/PollOptionAddedContext.md) | contexts/index.d.ts:6990 |
|  `poll_option_deleted` | *typeof* [`PollOptionDeletedContext`](classes/PollOptionDeletedContext.md) | contexts/index.d.ts:6991 |
|  `pre_checkout_query` | *typeof* [`PreCheckoutQueryContext`](classes/PreCheckoutQueryContext.md) | contexts/index.d.ts:6993 |
|  `proximity_alert_triggered` | *typeof* [`ProximityAlertTriggeredContext`](classes/ProximityAlertTriggeredContext.md) | contexts/index.d.ts:6994 |
|  `purchased_paid_media` | *typeof* [`PaidMediaPurchasedContext`](classes/PaidMediaPurchasedContext.md) | contexts/index.d.ts:7029 |
|  `refunded_payment` | *typeof* [`RefundedPaymentContext`](classes/RefundedPaymentContext.md) | contexts/index.d.ts:7014 |
|  `removed_chat_boost` | *typeof* [`RemovedChatBoostContext`](classes/RemovedChatBoostContext.md) | contexts/index.d.ts:7033 |
|  `service_message` | *typeof* [`MessageContext`](classes/MessageContext.md) | contexts/index.d.ts:7028 |
|  `shipping_query` | *typeof* [`ShippingQueryContext`](classes/ShippingQueryContext.md) | contexts/index.d.ts:7012 |
|  `successful_payment` | *typeof* [`SuccessfulPaymentContext`](classes/SuccessfulPaymentContext.md) | contexts/index.d.ts:7013 |
|  `suggested_post_approval_failed` | *typeof* [`SuggestedPostApprovalFailedContext`](classes/SuggestedPostApprovalFailedContext.md) | contexts/index.d.ts:7002 |
|  `suggested_post_approved` | *typeof* [`SuggestedPostApprovedContext`](classes/SuggestedPostApprovedContext.md) | contexts/index.d.ts:7001 |
|  `suggested_post_declined` | *typeof* [`SuggestedPostDeclinedContext`](classes/SuggestedPostDeclinedContext.md) | contexts/index.d.ts:7003 |
|  `suggested_post_paid` | *typeof* [`SuggestedPostPaidContext`](classes/SuggestedPostPaidContext.md) | contexts/index.d.ts:7004 |
|  `suggested_post_refunded` | *typeof* [`SuggestedPostRefundedContext`](classes/SuggestedPostRefundedContext.md) | contexts/index.d.ts:7005 |
|  `unique_gift` | *typeof* [`UniqueGiftContext`](classes/UniqueGiftContext.md) | contexts/index.d.ts:7019 |
|  `users_shared` | *typeof* [`UsersSharedContext`](classes/UsersSharedContext.md) | contexts/index.d.ts:7015 |
|  `video_chat_ended` | *typeof* [`VideoChatEndedContext`](classes/VideoChatEndedContext.md) | contexts/index.d.ts:7023 |
|  `video_chat_participants_invited` | *typeof* [`VideoChatParticipantsInvitedContext`](classes/VideoChatParticipantsInvitedContext.md) | contexts/index.d.ts:7024 |
|  `video_chat_scheduled` | *typeof* [`VideoChatScheduledContext`](classes/VideoChatScheduledContext.md) | contexts/index.d.ts:7025 |
|  `video_chat_started` | *typeof* [`VideoChatStartedContext`](classes/VideoChatStartedContext.md) | contexts/index.d.ts:7026 |
|  `web_app_data` | *typeof* [`WebAppDataContext`](classes/WebAppDataContext.md) | contexts/index.d.ts:7027 |
|  `write_access_allowed` | *typeof* [`WriteAccessAllowedContext`](classes/WriteAccessAllowedContext.md) | contexts/index.d.ts:6995 |

#### 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:6942

Array of EVENTS

***

### filterPayload

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

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

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:6938

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:6934

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:4479

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:4482 |
|  `preview` | *typeof* [`PaidMediaPreview`](classes/PaidMediaPreview.md) | contexts/index.d.ts:4480 |
|  `video` | *typeof* [`PaidMediaVideo`](classes/PaidMediaVideo.md) | contexts/index.d.ts:4481 |

***

### SERVICE\_MESSAGE\_EVENTS

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

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

Array of SERVICE\_MESSAGE\_EVENTS

## Functions

### memoizeGetters()

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

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

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:5338

#### 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

from Telegram Bot API 9.6

***

### 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

| Name | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| `_` | `object` | - | i18n/index.d.ts:61 |
| `_.languages` | `Languages` | - | i18n/index.d.ts:62 |
| `_.primaryLanguage` | `PrimaryLanguage` | - | i18n/index.d.ts:63 |
| `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 |
| `localesFor()` | (`key`, ...`args`) => `Record`<`string`, `string`> | Generate a `{ languageCode: description }` record for all non-primary languages. Designed for use with `CommandMeta.locales` in `syncCommands()`. Only includes languages where the key resolves to a plain string (no args). **Example** `bot.command("help", { description: i18n.t("en", "cmd.help"), locales: i18n.localesFor("cmd.help"), }, (ctx) => ctx.send("Help"));` | i18n/index.d.ts:60 |

***

### 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) | Scene IS an EventComposer. Inherits the full gramio DSL (`.command/.callbackQuery/.hears/.on/.use/.derive/.guard/.branch/.extend/...`) and adds scene-specific methods (`.params/.state/.exitData/.onEnter/.step/ .ask`). Scene-specific data lives on `this["~scene"]` to avoid colliding with the composer's own `~` slot. |

## Interfaces

| Interface | Description |
| ------ | ------ |
| [EnterExit](interfaces/EnterExit.md) | - |
| [InActiveSceneHandlerReturn](interfaces/InActiveSceneHandlerReturn.md) | - |
| [InUnknownScene](interfaces/InUnknownScene.md) | - |
| [ParentSceneFrame](interfaces/ParentSceneFrame.md) | - |
| [PossibleInUnknownScene](interfaces/PossibleInUnknownScene.md) | - |
| [SceneEnterHandler](interfaces/SceneEnterHandler.md) | `enter(scene, params?)` typed via two overloads so each case is checked cleanly without relying on a conditional-rest-args dance (which expect- type's `toBeCallableWith` can't fully resolve under generic constraints): |
| [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) | - |
| [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:886

#### 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?`): [`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `object`, { }>

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

#### 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

[`Plugin`](../../../gramio/classes/Plugin.md)<{ }, [`DeriveDefinitions`](../../../gramio/type-aliases/DeriveDefinitions.md) & `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.

### Throw safety (since v0.0.3)

Even when your handler throws, the plugin still calls `answerCallbackQuery` — so the user never ends up with a stuck spinner on the button. The middleware wraps the handler in `try/finally`, so the auto-answer runs in the `finally` branch regardless of the error:

```ts
bot.callbackQuery("test", async (context) => {
    throw new Error("boom");
    // The plugin still answers the callback query —
    // the spinner clears, then the error reaches your bot.onError handler.
});
```

---

---
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-05-31.md'
---

# Bot API 10.0 Lands Ecosystem-Wide & Scenes Become Composers

**May 8 – 31, 2026**

Two headline stories this cycle. First, **Telegram Bot API 10.0** rolls out across the entire stack — `@gramio/types` v10, `@gramio/contexts` v0.7, `@gramio/files` v0.5, `@gramio/format` v0.8, and `gramio` v0.10 — bringing live photos, guest messages, poll media, message-reaction permissions, and bot access settings. Second, **`@gramio/scenes` v0.7** ships the long-promised *scene-as-composer* redesign: every `Scene` is now a full `EventComposer`, each step is its own sub-composer with `.enter`/`.exit`/`.fallback`, scenes compose into reusable step modules, and there's a new `onExit` lifecycle hook. Plus `@gramio/onboarding` v0.2 makes `ctx.onboarding` flow through `bot.extend()` with zero ceremony.

## [Bot API 10.0 — Live Photos, Guest Messages, Poll Media](https://github.com/gramiojs/types/commit/cd2e4628207af795d276e112113fa79a103c84cb)

`@gramio/types` **v10.0.0** regenerates the full type surface for [Telegram Bot API 10.0](https://core.telegram.org/bots/api-changelog), and `@gramio/contexts` **v0.7.0** lights it up with [first-class context getters and mixins](https://github.com/gramiojs/contexts/commit/3ccbb1c91a33f0ea4feb22523368c3ff145728d6).

### [New attachment: live photos](https://github.com/gramiojs/contexts/commit/3ccbb1c91a33f0ea4feb22523368c3ff145728d6)

A new `LivePhotoAttachment` plus `Message.livePhoto`, `ExternalReplyInfo.livePhoto`, and a `sendLivePhoto` mixin:

```ts
bot.on("message", (ctx) => {
    if (ctx.livePhoto) return ctx.send("Nice live photo!");
});

await bot.api.sendLivePhoto({ chat_id, live_photo: "/path/to/live.mov" });
```

### Guest messages

Bot API 10.0 introduces **guest messages** — a new `guest_message` update where users interact with your bot without a regular chat. GramIO maps it to `MessageContext`, exposes `Message.guestQueryId` / `guestBotCallerUser` / `guestBotCallerChat`, adds `MessageContext.answerGuestQuery()`, and `User.supportsGuestQueries()`. The framework-level [`bot.guestQuery(...)`](#bot-guestquery-handle-guest-messages) shorthand lands in `gramio` v0.10 (below).

### Polls gain media

Polls and their options can now carry media. `Poll` gains `media`, `explanationMedia`, `membersOnly`, and `countryCodes`; `PollOption` gains `media`. `sendPoll` accepts per-option media, and `correctOptionId` is now `correctOptionIds` (an array) per the API change.

### Reactions you can delete, and react-permissions

* `NodeMixin` gains `deleteReaction` and `deleteAllReactions`.
* `ChatPermissions.canReactToMessages` and `ChatMember.canReactToMessages()` expose the new react-permission bit.
* `ChatMemberControlMixin` adds `getUserPersonalChatMessages`, `getManagedBotAccessSettings`, and `setManagedBotAccessSettings`; new `BotAccessSettings` / `SentGuestMessage` structures back them.

### [`@gramio/files` v0.5.0 & `@gramio/format` v0.8.0 regenerated](https://github.com/gramiojs/files/commit/51a443164367589c36c56fd8d05c100d3cbb2125)

`@gramio/files` switched its generator to [`@gramio/schema-parser`](https://github.com/gramiojs/files/commit/51a443164367589c36c56fd8d05c100d3cbb2125) (fetching the live schema instead of a vendored JSON) and regenerated `MEDIA_METHODS` — picking up `sendLivePhoto`, `sendPoll`, `setMyProfilePhoto`, plus extra cover/photo/live-photo fields on `sendVideo`, `sendMediaGroup`, `sendPaidMedia`, and `editMessageMedia`. `@gramio/format` [regenerated its mutator](https://github.com/gramiojs/format/commit/ef67952a3874e4767062fddd1f1853563be0f675) for `sendLivePhoto`, `answerGuestQuery`, and the new `explanation_media` / per-option `media` formattables. Both bumped their `@gramio/types` peer to `^10.0.0`.

## [gramio v0.10.0 — Guest Queries, CallbackData Inline Results, Updates Fix](https://github.com/gramiojs/gramio/compare/v0.9.0...v0.10.0)

### [Bot API 10.0 support](https://github.com/gramiojs/gramio/commit/15f2aeac6fe926161c51a223524d13ecc5f02af1)

`gramio` v0.10.0 wires up the Bot API 10.0 dependency line (`@gramio/types ^10`, `@gramio/contexts ^0.7`, `@gramio/files ^0.5`, `@gramio/format ^0.8`, `@gramio/test ^0.7`) and adds `guest_message` to the `allowed_updates` filter.

### `bot.guestQuery()` — handle guest messages

A new shorthand mirroring `inlineQuery`: it accepts a string / RegExp / predicate trigger (or none, to match any guest message), captures args, and supports macro-options. Reply with `ctx.answerGuestQuery(result)`, where `result` is a single `InlineQueryResult`:

```ts
import { InlineQueryResult, InputMessageContent } from "gramio";

bot.guestQuery(async (ctx) => {
    // a user reached the bot via a guest message
    await ctx.answerGuestQuery(
        InlineQueryResult.article("1", "Hi!", InputMessageContent.text("Hello, guest!")),
    );
});

// or filter on the guest query text
bot.guestQuery(/^help/i, (ctx) =>
    ctx.answerGuestQuery(
        InlineQueryResult.article("help", "Help", InputMessageContent.text("How can I help?")),
    ),
);
```

It's deliberately separate from `command`/`hears`/`startParameter` — guest messages have different reply semantics (`answerGuestQuery`, not `ctx.send`/`reply`). See the new [`guestQuery` trigger page](/triggers/guest-query).

### [`chosenInlineResult` accepts a CallbackData schema](https://github.com/gramiojs/gramio/commit/936ca16e37788e2c551fc544ef3891ecb95c49de)

`bot.chosenInlineResult(schema, handler)` now filters on `result_id` and unpacks into a typed `ctx.queryData`, exactly like `callbackQuery(schema, …)`:

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

const card = new CallbackData("card").number("id");

bot.inlineQuery(/cards/, (ctx) =>
    ctx.answer([
        InlineQueryResult.article(card.pack({ id: 42 }), "Card #42", /* … */),
    ]),
);

bot.chosenInlineResult(card, (ctx) => {
    ctx.queryData.id; // ✅ typed as number
});
```

String / RegExp / predicate triggers still match against `query` as before.

### [No-trigger `bot.inlineQuery(handler)` overload](https://github.com/gramiojs/gramio/commit/15f2aeac6fe926161c51a223524d13ecc5f02af1)

`bot.inlineQuery(handler)` (no trigger) now matches **any** inline query — handy for the auth-redirect pattern where you answer with an empty result set plus a login `button`.

### [Plugin authors: subclass-overlay helpers re-exported](https://github.com/gramiojs/gramio/commit/fa761ca1b8f2717aad7e547d611bd79babfa66e7)

`WithDerives`, `WithEventDerive`, `WithDecorate`, `WithExtend`, and `DeriveHandler` are now re-exported from `gramio` directly, so plugin authors building Composer-derived classes (like `Scene`) can import them without reaching into `@gramio/composer`.

### [Fix: no lost updates when stopping mid-batch](https://github.com/gramiojs/gramio/commit/f51a55d62ec0735627532f3fb68499d048b06986)

When `bot.stop()` flipped `isStarted` to `false` while a `getUpdates` batch was in flight, the offset was advanced locally (confirming the batch on Telegram's side) while the batch was dropped — silently losing those updates. v0.10 abandons such a batch without advancing the offset, so Telegram re-delivers it on the next start.

### [Fix: typed bots assignable to `webhookHandler`](https://github.com/gramiojs/gramio/commit/36bef2e3de4358263ba5e6312b379c112810c4a8)

Bots with derives/plugins/macros couldn't be passed to `webhookHandler` without `as any` because their generics sat in contravariant positions. The parameter widened to `AnyBot`, so the cast is gone.

## [@gramio/scenes v0.7 — Scenes Become Composers](https://github.com/gramiojs/scenes/compare/v0.6.0...v0.7.1)

The biggest scenes release ever. `Scene` now [extends `EventComposer`](https://github.com/gramiojs/scenes/commit/200a3ff90cfc67c6a7200c37d93a4cacc3e01eed), so the full bot-level DSL — `.use`/`.on`/`.derive`/`.decorate`/`.guard`/`.command`/`.callbackQuery`/`.hears`/… — is available directly on every scene. On top of that foundation come three big DX wins.

### [Builder steps — each step is its own sub-composer](https://github.com/gramiojs/scenes/commit/5437bb284049d93bfef1c13a7e8491df03846cad)

The new recommended way to define a step: pass a builder callback that receives a per-step composer with `.enter` / `.exit` / `.fallback` / `.message` lifecycle hooks plus the full event surface (`.on` / `.command` / `.callbackQuery` / `.hears`):

```ts
import { Scene } from "@gramio/scenes";

const checkout = new Scene("checkout")
    .step("ask-name", (c) =>
        c
            .message("What's your name?") // sugar for .enter(ctx => ctx.send(...))
            .on("message", (ctx) => ctx.scene.update({ name: ctx.text })),
    )
    .step("confirm", (c) =>
        c
            .enter((ctx) => ctx.send(`${ctx.scene.state.name}, confirm? (yes/no)`))
            .hears("yes", (ctx) => ctx.scene.exit())
            .fallback((ctx) => ctx.send("Please answer yes or no")),
    );
```

### [State auto-inferred from `ctx.scene.update()`](https://github.com/gramiojs/scenes/commit/f815bb05982599e737ca827a859bcbe49b4747e4)

Builder steps thread the shape you pass to `ctx.scene.update({...})` into `ctx.scene.state` for every later step — no `.state<T>()` declaration needed:

```ts
new Scene("signup")
    .step("ask", (c) =>
        c.on("message", (ctx) => ctx.scene.update({ name: ctx.text! })),
    )
    .step("greet", (c) =>
        c.enter((ctx) => {
            ctx.scene.state.name; // ✅ inferred as string
        }),
    );
```

### [Reusable step modules — `scene.extend(otherScene)`](https://github.com/gramiojs/scenes/commit/87b77915c2cf3853180c2d471fe3c4bd9338d5a8)

Define a nameless `Scene` as a reusable block of steps and `.extend()` it into any named scene. Named-step collisions throw; numeric steps are renumbered automatically:

```ts
// A reusable confirmation module — cannot be entered directly
const confirm = new Scene().step("confirm", (c) =>
    c
        .enter((ctx) => ctx.send("Are you sure?"))
        .callbackQuery("yes", (ctx) => ctx.scene.step.next())
        .callbackQuery("no", (ctx) => ctx.scene.exit()),
);

const order = new Scene("order")
    .step("review", (c) => c.enter((ctx) => ctx.send("Review your order")))
    .extend(confirm) // ← pulls in the "confirm" step
    .step("done", (c) => c.enter((ctx) => ctx.send("Order placed!")));
```

### [`onExit` lifecycle hook + `derive` visible in `onEnter`](https://github.com/gramiojs/scenes/commit/13389f1d4e8cbef994f3474b94fc937256cb14c6)

Symmetric to `onEnter`, the new `onExit` fires when a user leaves a scene (via `exit()`, `exitSub()`, or `reenter()`) **before** storage is torn down — perfect for cleanup or a "thanks for completing" message. And [scene-level `.derive()` results are now visible inside `onEnter`](https://github.com/gramiojs/scenes/commit/51c1284e53873178c88cc82bb5893a3016ce2d29), so you can load data and react to it on entry in one chain:

```ts
const checkout = new Scene("checkout")
    .derive(async (ctx) => ({ user: await db.users.find(ctx.from!.id) }))
    .onEnter((ctx) => analytics.track("checkout_start", { user: ctx.user }))
    .onExit((ctx) => ctx.send("Thanks for stopping by!"))
    .step("review", (c) => c.message("Looks good?").on("message", confirm));
```

> The classic event-filter step form — `.step("message", handler)` and `.step(["message", "callback_query"], handler)` — is **fully supported** and works alongside builder steps in the same scene. Reach for builder steps in new code for the cleaner per-step lifecycle and automatic state inference. See the [scenes guide](/plugins/official/scenes) for both forms side by side.

### [v0.7.1 — onEnter-consumed derives run exactly once again](https://github.com/gramiojs/scenes/commit/aef47af5211bff1af573498e8f2f53f987afe9de)

A quick follow-up patch: 0.7.0 could run a scene-level `.derive()` **twice** on the entry update when its result was consumed inside `onEnter` (once so `onEnter` could see it, once in the dispatch chain). [`@gramio/scenes` 0.7.1](https://github.com/gramiojs/scenes/compare/v0.7.0...v0.7.1) restores exactly-once-per-update execution — important if your derive has side effects (counters, spans, DB writes). Upgrade straight to **0.7.1**.

## [@gramio/onboarding v0.2.0 — Typed `build()`](https://github.com/gramiojs/onboarding/commit/957c74a1d32d11a2d72f46ca03bb30cd1ff02c57)

`createOnboarding({ id: "welcome" }).…​.build()` previously returned a plain `Plugin`, erasing the derive shape — so `ctx.onboarding.welcome` needed module augmentation or a cast at every call site. v0.2 threads the flow `Id` through the whole builder, so `bot.extend(...)` now widens `ctx.onboarding.welcome` automatically:

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

const bot = new Bot(process.env.BOT_TOKEN!).extend(
    createOnboarding({ id: "welcome" })
        .step("hi", { text: "Hi!" })
        .step("done", { text: "All set!" })
        .build(),
);

bot.command("start", (ctx) => {
    ctx.onboarding.welcome.start(); // ✅ typed, no augmentation needed
    return ctx.send("Let's go!");
});
```

No runtime changes — type-level only — but consumers that relied on the old plain-`Plugin` return will pick up stricter inference.

## Documentation & Skills

* **New [`guestQuery` trigger page](/triggers/guest-query)** documenting the Bot API 10 guest-message flow.
* **Scenes docs restructured** to lead with the builder-step API while keeping the event-filter form documented as an equal alternative.
* **New [deep-links reference](https://github.com/gramiojs/documentation/commit/d356afa64919c15c85f2117783fee654df025502)** in the AI skills — a single source of truth for every `t.me/<bot>?…` link family (`?start=`, `?startapp=`, `?startgroup=`, payload encoding, `admin=` tokens) so downstream agents route each link correctly.
* **Telegram method/type reference pages updated to Bot API 10.0**, plus a [twoslash + Vite build pass](https://github.com/gramiojs/documentation/commit/7ba60a4f2d7d31ae0321b004e0173399a154d7ca) across ~200 snippets.

---

---
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/changelogs/2026-05-08.md'
---

# Bot API 9.6, gramio 0.9, and a New Onboarding Plugin

**March 2 – May 8, 2026**

The biggest cycle since the framework's 0.5 launch. Telegram Bot API 9.6 lands across the ecosystem with managed bots, richer polls, and new entity helpers. **gramio 0.9** ships `bot.syncCommands()` for automatic Telegram command-menu sync, full Plugin shorthand methods, and an `allowed_updates` builder that auto-derives from registered handlers. The brand-new **`@gramio/onboarding`** plugin provides declarative tutorials with multi-flow concurrency, scope-aware rendering, and pluggable storage. **`@gramio/scenes` 0.6** finally stops eating your global `/cancel` and `/help` commands. **`@gramio/views` 0.2** adds lazy globals that re-evaluate per render. And **wrappergram v2** is a complete middleware-based rewrite that powers it all underneath.

## [gramio v0.9.0 — Command Sync, Plugin Shorthands, Smart Allowed Updates](https://github.com/gramiojs/gramio/compare/v0.7.0...v0.9.0)

### [`bot.syncCommands()` — Telegram menu sync without ceremony](https://github.com/gramiojs/gramio/commit/b5043cd7d3b9796a92d44c33630004d1a55223a4)

Declaring a `/command` is half the battle — the other half is keeping Telegram's command menu in sync. `bot.command()` now accepts optional `CommandMeta` (description, locales, scopes, hide), and a single `bot.syncCommands()` call flushes everything to Telegram with hash-based caching so unchanged metadata doesn't burn rate-limit budget.

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

const bot = new Bot(process.env.BOT_TOKEN!)
    .command("start", { description: "Start the bot" }, (ctx) => ctx.send("Hello!"))
    .command(
        "help",
        { description: "Show help", locales: { ru: "Помощь", uk: "Допомога" } },
        (ctx) => ctx.send("Help!"),
    )
    .command(
        "admin",
        { description: "Admin panel", scopes: [{ type: "chat_administrators" }] },
        adminHandler,
    )
    .command("debug", { hide: true }, debugHandler);

bot.onStart(() => bot.syncCommands());
await bot.start();
```

The `meta` argument sits **between** the command name and the handler — `bot.command(name, meta, handler)`. The plain two-arg form `bot.command(name, handler)` still works for commands you don't want in the menu.

`syncCommands()` groups commands by scope, deduplicates by hash, and skips entire scopes when nothing changed. Pair it with the new [`localesFor()` helper from `@gramio/i18n`](#i18n-1-5-localesfor-bridges-i18n-keys-to-syncCommands) to drive locales straight from your translation files.

### [Plugin shorthand methods — `Plugin().command(...)` works directly](https://github.com/gramiojs/gramio/commit/d7b8db54b29facd44d6a91256272388a8e4cc259)

Until now, encapsulating a feature as a Plugin meant routing through the plugin's internal composer just to register handlers. Plugins now expose `command`, `callbackQuery`, `hears`, `reaction`, `inlineQuery`, `chosenInlineResult`, and `startParameter` as direct methods, sharing the same implementation as `Bot` and `Composer`:

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

const adminPlugin = new Plugin("admin")
    .command("ban", banHandler)
    .command("unban", unbanHandler)
    .callbackQuery(adminAction, callbackHandler);

bot.extend(adminPlugin);
```

`composer.extend(plugin).command(...)` chains correctly without losing accumulated `TMethods` typings ([77f8c02](https://github.com/gramiojs/gramio/commit/77f8c02a750845c88e3aa5a46641e59c87bdc770)). `Plugin.extend(plugin)` now propagates middleware, hooks, decorators, error definitions, groups, and dependencies — previously it carried only types.

### [`AllowedUpdatesFilter` — derive `allowed_updates` from registered handlers](https://github.com/gramiojs/gramio/commit/9f522ea0346c75aad3bc05a44ccb5a9d3b3565fc)

`chat_member`, `message_reaction`, and `message_reaction_count` are the three update types Telegram excludes from `getUpdates`/`setWebhook` unless explicitly listed in `allowed_updates` — silently dropping them is an evergreen footgun. GramIO 0.9 fixes this in two ways:

```ts
import { Bot, AllowedUpdatesFilter } from "gramio";

const bot = new Bot(token)
    .on("chat_member", chatMemberHandler)
    .on("message_reaction", reactionHandler);

// 1. Default — no arg. GramIO scans your handlers and auto opt-ins to
//    chat_member / message_reaction / message_reaction_count when registered.
await bot.start();

// 2. Strict mode — only request the update types your handlers register for,
//    nothing else. Pass the literal string "strict".
await bot.start({ allowedUpdates: "strict" });

// 3. Explicit fluent builder — immutable Array<AllowedUpdateName>.
await bot.start({
    allowedUpdates: AllowedUpdatesFilter.only("message", "callback_query"),
});

// 4. Default set with extras / exclusions.
await bot.start({
    allowedUpdates: AllowedUpdatesFilter.default
        .add("chat_member")
        .except("poll", "poll_answer"),
});
```

Available factories: `AllowedUpdatesFilter.all` / `.default` / `.only(...types)`, with `.add(...)` and `.except(...)` chaining on any instance.

### [`AnyBot` no longer collapses `ctx.isPM()` / `isGroup()` / `isChannel()` to `never`](https://github.com/gramiojs/gramio/commit/24ea8f2d08d657fab3270b73678d927d69e8a86a)

A long-standing TypeScript bug ([gramiojs/gramio#28](https://github.com/gramiojs/gramio/issues/28), fixed in `@gramio/contexts` 0.5.1): on Bot/Composer command and message handlers, `ctx.isPM()` and friends would narrow `ctx` to `never` instead of the expected branch. Fixed upstream in contexts and pulled into gramio 0.8.3+.

### [Bot instance available in `onStart` / `onStop` hooks](https://github.com/gramiojs/gramio/commit/5b742f28c2cc1b9e289d0f19a591c811ba5ac23b)

Both lifecycle hooks now receive the bot instance, so you can call `bot.api.*` during startup/shutdown without capturing a closure:

```ts
bot.onStart(({ bot, info }) => bot.api.sendMessage({ chat_id: ADMIN, text: `Started as @${info.username}` }));
```

**Updated packages in this release:** `gramio` v0.9.0, `@gramio/contexts` v0.6.1, `@gramio/types` v9.6.1, `@gramio/files` v0.4.0, `@gramio/format` v0.7.0, `@gramio/keyboards` v1.4.0, `@gramio/composer` v0.4.1, `@gramio/test` v0.7.0.

## [Bot API 9.6 — Managed Bots, Richer Polls, New Entities](https://github.com/gramiojs/types/commit/e4a94d2ed44ec0ace9a38de88ac3629434f26015)

### [Managed bots: ManagedBotCreated, ManagedBotUpdated, and the new `managed_bot` update](https://github.com/gramiojs/contexts/commit/23ffd45d939ec63d28e0a39dcc64e7e5f0fe1030)

Telegram's new managed-bot model lets a parent bot programmatically manage child bots. GramIO surfaces this through new contexts (`managed_bot`, `managed_bot_created`), new structures (`ManagedBotCreated`, `ManagedBotUpdated`), and `User.canManageBots()`. The `ChatMemberControlMixin` gains `getManagedBotToken()` and `replaceManagedBotToken()`, so token rotation lives next to the chat admin APIs. `@gramio/keyboards` 1.4.0 ships the [`requestManagedBot` button](https://github.com/gramiojs/keyboards/commit/8dfe5e23bfc2e50b0177416026150a02b1cdfe39) for picking a managed bot from a Telegram dialog.

### [Polls overhauled — option add/remove, revoting, descriptions, persistent IDs](https://github.com/gramiojs/contexts/commit/23ffd45d939ec63d28e0a39dcc64e7e5f0fe1030)

Polls in 9.6 are no longer immutable. Two new updates — `poll_option_added` and `poll_option_deleted` — fire as users mutate poll structure. `Poll` gains `allowsRevoting`, `description`, and `descriptionEntities`; `correctOptionId` is now `correctOptionIds` (array). `PollOption` gets `persistentId`, `addedByUser`, `addedByChat`, and `additionDate`. `PollAnswer` adds `optionPersistentIds`. `Message` gets `replyToPollOptionId`, `managedBotCreated`, `pollOptionAdded`, `pollOptionDeleted`.

### [Mojibake guard for emoji enums](https://github.com/gramiojs/types/commit/ed338fa3ae877beea0714b7ca7c91696f0126b92)

`@gramio/types` 9.6.0 briefly shipped corrupted `SendDiceEmoji` values (`"рџЋІ"`) when the upstream HTTP response was decoded as windows-1251. 9.6.1 throws on detection of the `"рџ"` byte sequence and the regenerated package has clean unicode again.

## [@gramio/onboarding v0.1.0 — New Official Plugin](https://github.com/gramiojs/onboarding/commit/f4af692878138e4eb4409bdb057efc430c5274bc)

### [Declarative user tutorials with multi-flow concurrency](https://github.com/gramiojs/onboarding/commit/f4af692878138e4eb4409bdb057efc430c5274bc)

A brand-new official plugin for walking users through your bot's features one step at a time. Steps advance on a "Next" button, on the user actually completing the action (`advanceOn`), or programmatically from a real handler (`ctx.onboarding.<flow>.next({ from })`). Multiple flows compose independently — `welcome`, `premium-upsell`, `new-feature` — with three concurrency modes (`queue`, `preempt`, `parallel`).

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

const welcome = createOnboarding({ id: "welcome" })
    .step("hi", { text: "Hi! I'll show you around.", buttons: ["next", "exit"] })
    .step("links", { text: "Send me any link — I'll download it.", buttons: ["next", "dismiss"] })
    .step("done", { text: "All set!" })
    .onComplete((ctx) => ctx.send("Welcome aboard! /help is always available."))
    .build();

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

bot.command("start", (ctx) => {
    ctx.onboarding.welcome.start();
    return ctx.send("Let's start!");
});
```

Highlights:

* **Refusal ladder** — `next → skip → exit → dismiss → disableAll`, all opt-in via buttons.
* **Scope-aware rendering** — `renderIn: "dm" | "group" | "any"` defers a step when the current chat doesn't fit and re-renders on the next eligible update.
* **Fire-and-forget API** — every `ctx.onboarding.*` call swallows errors and forwards them to `bot.errorHandler`, never throws into your business logic.
* **Storage-agnostic** — pluggable `Storage<OnboardingStorageMap>` via `@gramio/storage` (memory / redis / sqlite / cloudflare). A framework-agnostic `getStorageContractCases()` helper lets adapter authors verify their adapter against the full contract.
* **Optional [`@gramio/views`](/plugins/official/views) integration** — pass `step.view` and use the new lazy-globals support so views always see the live onboarding tokens.

Full reference: [`/plugins/official/onboarding`](/plugins/official/onboarding).

## [@gramio/scenes v0.6.0 — Stop Eating Global Commands](https://github.com/gramiojs/scenes/compare/v0.4.0...v0.6.0)

### [Passthrough: non-matching updates flow to outer handlers](https://github.com/gramiojs/scenes/commit/b6683583e8108ac5987bd0682fb3dbdda48ab90e)

Previously, while a user was inside a scene, any update that didn't match the current step was silently swallowed. A user stuck mid-form couldn't run `/cancel` or `/help` registered outside the scene. **0.6.0 flips the default**: non-matching updates now propagate to the rest of the bot chain, while the scene preserves its `firstTime` state so the user doesn't lose their place. Opt out with `passthrough: false` to restore the legacy greedy behavior.

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

const bot = new Bot(token)
    .extend(scenes([signupScene]))      // passthrough: true by default
    .command("cancel", (ctx) => ctx.scene?.exit()); // now actually fires!
```

### [Sub-scenes and `enterSub()` / `exitSub()`](https://github.com/gramiojs/scenes/commit/fc40b15e533b119360196dc4beac284ee30476ce)

Scenes can now nest. `ctx.scene.enterSub(otherScene, params)` pushes the current scene onto a parent stack, runs the sub-scene to completion, then automatically returns to the caller's next step. The stack is persisted on the storage record, so a process restart resumes correctly. Use `.exitData<T>()` on a sub-scene to type the data it returns to the parent:

```ts
const pickAddress = new Scene("pick-address")
    .exitData<{ address: string }>()
    .step("ask", (ctx) => ctx.send("Send your address as text"))
    .step("save", (ctx) => ctx.scene.exitSub({ address: ctx.text! }));

const checkout = new Scene("checkout")
    .step("address", async (ctx) => {
        await ctx.scene.enterSub(pickAddress);   // pauses checkout, runs pickAddress
    })
    .step("confirm", (ctx) => {
        // pickAddress resolved — its exitData is on ctx.scene.state via the parent merge
        return ctx.send("Confirm order?");
    });
```

### [`scene.reenter(params)` and typed `scene.enter()` params](https://github.com/gramiojs/scenes/commit/69a57b744a824e72b3b52b9013870ef7bfc0c55d)

`reenter()` now accepts params, and `scene.enter()` properly type-checks the params tuple at the call site instead of falling back to `any` ([c5b2dc5](https://github.com/gramiojs/scenes/commit/c5b2dc5084ba487447cddaba378ec591401e16a2), closes [#6](https://github.com/gramiojs/scenes/issues/6)).

### [`scenesDerives` uses `Plugin` for proper deduplication](https://github.com/gramiojs/scenes/commit/eef792bed5ba0ca4b88faf46c14276d35b3f47ce)

Fixes [#5](https://github.com/gramiojs/scenes/issues/5) — `context.scene` was undefined when `scenesDerives` was extended via `Composer` because gramio couldn't dedupe an unnamed Composer. Switching to `Plugin` resolves the bug and unlocks shared storage between bot-level handlers and scene steps.

## [@gramio/format v0.7.0 — Block Separator Fix, Regenerated for Bot API 9.6](https://github.com/gramiojs/format/compare/v0.4.0...v0.7.0)

### [Markdown: preserve newlines between adjacent block tokens](https://github.com/gramiojs/format/commit/a9177615cf76b45371491b2314a47f13167d67db)

A subtle but critical bug for any LLM-driven bot: marked stores a block's trailing newlines on its own `raw` field, so joining top-level tokens with an empty separator glued adjacent blocks together. `"Agenda:\n- one\n- two"` rendered as `"Agenda:- one\n- two"` — every enumerated assistant reply was wrong in production. The fix generalizes the previous heading-only workaround into `normalizeBlockSeparators`, covering paragraph+list, paragraph+blockquote, paragraph+code, heading+anything.

### [Mutator regenerated on `@gramio/schema-parser`](https://github.com/gramiojs/format/commit/a100955fd72dff9230b6da4f734bb40913bdb8ee)

Replaces the old `tg-bot-api/custom.min.json` pipeline with `@gramio/schema-parser`'s `getCustomSchema()`. The generator walks method parameters recursively, deduplicates transforms, and now covers 32 methods including `sendMessageDraft`, `sendPaidMedia`, `sendPoll.description`, `sendChecklist`, and `editMessageChecklist`.

### [`formatMiddleware` for the wrappergram v2 chain](https://github.com/gramiojs/format/commit/83b62174ea42dc3c3186bd3613e324272a7bedc6)

`@gramio/format/middleware` now exports a ready-to-use middleware that decomposes `FormattableString` values into `text + entities` before each Telegram API call — dropped into the new wrappergram v2 middleware chain (or any other) without going through the gramio plugin path.

## [@gramio/views v0.2.0 — Lazy Globals via Thunk](https://github.com/gramiojs/views/commit/4ae094d755d3eb79fb84d1eee8752f05138f04a0)

`buildRender` now accepts `Globals | (() => Globals)`. When a function is passed, it's invoked **per render** so views see fresh state from mutating sources — session, scene, onboarding snapshot, locale, role escalation. The adapter factory is also re-invoked per render with the resolved globals, so per-locale adapter selection keeps working when locale changes mid-handler:

```ts
bot.derive(["message", "callback_query"], (ctx) => ({
    render: defineView.buildRender(ctx, () => ({
        user: { id: ctx.from!.id, name: ctx.from!.firstName },
        // captured fresh per render — locale flip in middleware "just works"
        i18n: ctx.t,
        // onboarding tokens for the @gramio/onboarding plugin
        onboarding: getCurrentOnboardingTokens(),
    })),
}));
```

Plain-object form is unchanged. Property getters on plain-object globals already resolved per-render, so a getter mix is also valid.

## [@gramio/test v0.7.0 — Bubble Tracking, Telegram Payments, Type-Safe ApiCall](https://github.com/gramiojs/test/compare/v0.3.0...v0.7.0)

### [`env.lastBotMessage()` — bubble that tracks edits](https://github.com/gramiojs/test/commit/aeba8c7a19818f08bd8b66412355c71ecfd41f5e)

A `MessageObject` mirror of the bot's last `sendMessage`, kept in sync with `editMessageText` / `editMessageCaption` / `editMessageReplyMarkup` eagerly in the proxy, so references captured before an edit stay current. `user.on(bubble).clickByText(...)` now works across multiple edits on the same reference. `reply_markup` Builder instances (e.g. `InlineKeyboard`) are normalized via `.toJSON()` before recording, so no more `JSON.parse(JSON.stringify(...))` roundtrips in tests:

```ts
import { TelegramTestEnvironment } from "@gramio/test";
import { bot } from "./bot.js";

const env = new TelegramTestEnvironment(bot);
const user = env.user(1, { firstName: "Alice" });

await user.command("start");
const bubble = env.lastBotMessage();              // first send
await user.on(bubble).clickByText("Next →");      // bot edits the same message
// `bubble` now reflects the edited state — no manual refresh
expect(bubble.payload.text).toBe("Step 2 of 3");
```

### [`withReplyMarkup` and `where` predicate filters](https://github.com/gramiojs/test/commit/c6987127ccbc4bfd5c19e308e3804ecb511d6ee2)

```ts
const bubble = env.lastBotMessage({ withReplyMarkup: true });        // skip status/confirmation messages
const found  = env.lastBotMessage({ where: (call) => /Agenda/.test(call.params.text) });
```

### [Telegram Payments support](https://github.com/gramiojs/test/commit/11017d0e76958487baca8ec14a350316f945e34d)

`PreCheckoutQueryObject` and `ShippingQueryObject` builders, plus `user.sendPreCheckoutQuery()`, `user.sendShippingQuery()`, and `user.sendSuccessfulPayment()` for full payment flow simulation including bot pre-checkout approval verification.

### [Type-safe `ApiCall<Method>` and `filterApiCalls(method)`](https://github.com/gramiojs/test/commit/a6c953f27e6d484b84ced1bd84e51c8b9396812b)

`ApiCall<Method>` types `params`/`response` via `APIMethodParams`/`APIMethodReturn`. `lastApiCall("sendMessage")` returns a typed result, and the new `filterApiCalls("sendMessage")` returns `ApiCall<"sendMessage">[]` with full narrowing.

## [@gramio/composer v0.4.1 — `registeredEvents()` and `EventContextOf`](https://github.com/gramiojs/composer/compare/v0.3.0...v0.4.1)

### [`registeredEvents()` — introspect what's wired up](https://github.com/gramiojs/composer/commit/6781cb9dc13c968f447142136487c03c9a6f0e57)

Returns a `Set<string>` of event names registered via `.on()` and event-specific `.derive()`, including parsed composite events (`"message|callback_query"`) and entity patterns (`"message:text"`). Powers the auto-derived `allowed_updates` in gramio 0.9 above.

### [`EventContextOf<T, E>` — global + per-event derives in one type](https://github.com/gramiojs/composer/commit/6dae6fc0fb71859d4c2f100a5617c1d27c34f684)

When writing custom methods that target a specific event type, `EventContextOf<T, E>` extracts `TOut & TDerives[E]` from the composer instance, so per-event derives are visible without manual intersection:

```ts
import { Bot, EventContextOf } from "gramio";

const bot = new Bot(token)
    .derive(() => ({ session: { count: 0 } }))            // global derive
    .derive("callback_query", (ctx) => ({ payload: ctx.queryData })); // per-event

// Custom helper typed for callback_query — sees session AND payload
function bumpCounter(ctx: EventContextOf<typeof bot, "callback_query">) {
    ctx.session.count += 1;
    return ctx.answer({ text: `Got payload: ${ctx.payload}` });
}
```

Documented alongside the existing `ContextType` and `BotContext` patterns.

### [Framework-agnostic `commandsMeta` storage](https://github.com/gramiojs/composer/commit/516b6533b19375e8decbfd6c5ac5585e3523268d)

`commandsMeta` is now an `unknown`-valued Map instead of holding Telegram-specific `CommandMeta`/`ScopeShorthand` types. The Telegram-specific shape moved into gramio core where it belongs ([2429013](https://github.com/gramiojs/gramio/commit/2429013993b95f683a9d297f5e56e53a42deeed3)).

### [`guard()` predicate ctx no longer collapses to `any` after `derive()`](https://github.com/gramiojs/composer/commit/982334c600e55a1f4c3b48166b62d914d313ba8c)

The union of type-guard and boolean-predicate overloads caused TS to fall back to `any`. Splitting into two overloads restores proper contextual typing — fixes [#1](https://github.com/gramiojs/composer/issues/1).

## [@gramio/i18n v1.5 — `localesFor()` Bridges i18n Keys to syncCommands](https://github.com/gramiojs/i18n/commit/123c58feae88f0f662b034445db0cdf19ac25377)

A new method on the `defineI18n()` instance that returns `Record<string, string>` of all non-primary translations for a key — designed to drop straight into `CommandMeta.locales`:

```ts
import { defineI18n } from "@gramio/i18n";

const i18n = defineI18n({
    languages: { en, ru, uk },
    primaryLanguage: "en",
});

bot.command("help", {
    description: i18n.t("en", "cmd.help"),    // primary-locale string
    locales: i18n.localesFor("cmd.help"),      // { ru: "Помощь", uk: "Допомога" }
}, helpHandler);
```

`localesFor` iterates `Object.keys(languages)`, skips the primary, runs the same `t(lang, key, ...args)` translator that powers `ctx.t()`, and drops keys that resolve to `null`/missing — so partial language coverage is fine.

## [@gramio/auto-answer-callback-query v0.0.3 — Always Answers, Even on Throw](https://github.com/gramiojs/auto-answer-callback-query/commit/9361ccd1ba5450770ac0aadd5218df87e0eb3881)

Previously, a thrown handler would skip the auto-answer, leaving the user with a stuck spinner on the button. The middleware now wraps the handler in `try/finally` so `answerCallbackQuery` always runs.

## [@gramio/jsx — `<date-time>` Element](https://github.com/gramiojs/jsx/commit/5756a6076d53a6d2edc8e474fb4fb21cc2241047)

Supports the new `dateTime` entity from `@gramio/format` 0.5+ with `unixTime` and optional `format` props (`r`, `w`, `d`, `D`, `t`, `T`, `wDT`, `Dt`, etc.):

```tsx
<>Today is <date-time unixTime={Date.now() / 1000} format="D" /></>
```

## [wrappergram v2 — From Bare Proxy to Middleware Pipeline](https://github.com/gramiojs/wrappergram/commit/98973ee2dc410d9e69a0d03c1c859263ba745689)

The minimal Bot API wrapper that powers gramio's `bot.api` got a full rewrite. Previously, `wrappergram` shipped just a `Telegram` class with no extension points — every call ran a hardcoded `convertJsonToFormData → fetch → response.json()` pipeline, with `@gramio/files` as a mandatory dependency. v2 turns that pipeline into a middleware chain you can plug into:

```ts
// Before — no extension points, @gramio/files hard-coded
import { Telegram } from "wrappergram";
const tg = new Telegram(token);
const response = await tg.api.sendMessage({ chat_id, text });

// After — explicit middleware chain, files/format opt-in
import { Wrappergram, TelegramError } from "wrappergram";
import { filesMiddleware } from "@gramio/files/middleware";
import { formatMiddleware } from "@gramio/format/middleware";

const tg = new Wrappergram({
    token,
    middlewares: [
        async (ctx, next) => {
            const start = Date.now();
            await next();
            console.log(`${ctx.method} took ${Date.now() - start}ms`);
        },
        formatMiddleware,
        filesMiddleware,
    ],
});

// Suppress errors at the call site instead of try/catch
const result = await tg.sendMessage({ chat_id, text }, { suppress: true });
if (result instanceof TelegramError) {
    console.error("send failed:", result.code, result.payload);
}
```

Highlights:

* **Single `Middleware` type** — `(context, next) => unknown`. No 4-hook split, no callback soup.
* **First-class `TelegramError`** carrying `method`, `code`, `payload`, plus `captureStackTrace` so you get a real stack pointing at the call site.
* **`suppress: true` pattern** — returns `TelegramError | Result` instead of throwing. `SuppressedAPIMethods` infers the right return type at the type level via the `IsSuppressed` generic.
* **Per-request fetch options** ride along as the second argument to every API method.
* **`@gramio/files` is no longer a hard dependency** — opt-in via the new [`filesMiddleware`](https://github.com/gramiojs/files/commit/906829056432726961cb1ca76e270ba2ca0fa5bd) export from `@gramio/files/middleware`. Same pattern for `@gramio/format/middleware`. Bundle size drops for users who don't need them.

## Other Improvements

### [@gramio/schema-parser v1.1.0 — Shared-Sibling FormattableString Detection](https://github.com/gramiojs/schema-parser/commit/401f7ec1f660bca28987b83c5fb1ef7571fe1ead)

`InputTextMessageContent` drops the key prefix from its entity siblings (bare `parse_mode` / `entities` instead of `message_text_parse_mode`), so the existing per-field check missed it. The new shared-sibling fallback promotes the sole unmarked string field to `semanticType: "formattable"` when the object has both bare `parse_mode` and a bare `entities` array. Closes a long-standing gap that needed a manual workaround in `@gramio/format`'s mutator generator.

### [@gramio/contexts v0.5.1 — Type Narrowing Through `AnyBot`](https://github.com/gramiojs/contexts/commit/f782b5fb3784bc40e7e56d39c4cdd4e30ca81312)

When `Bot` generic was `AnyBot`, `__Derives` resolved to `any`, which collapsed `GetDerives` and `Context.is()` type narrowing. Fix from external contributor [@ttempaa](https://github.com/ttempaa) (PR [#3](https://github.com/gramiojs/contexts/pull/3)).

### [create-gramio v2.2.0 — Scoped Composer + Scene Step Inheritance](https://github.com/gramiojs/create-gramio/commit/c093d139a3bd8c82403924d93f261c69668373ff)

Generated projects now split `plugins/` into `base.ts` (named scoped composer with i18n / session / render) plus a thin assembly file. Scenes `.extend(baseComposer)` so step handlers get typed access to `ctx.t`, `ctx.render`, `ctx.session`, etc. Registration-time dedup on `name: "base"` keeps the middleware running exactly once per update. Also bumps gramio 0.5 → 0.9, scenes 0.3 → 0.6, views 0.0.5 → 0.2, test 0.3 → 0.7, and 8 other dependency lines.

### [ecosystem-ci — New Cross-Repo Compatibility Pipeline](https://github.com/gramiojs/ecosystem-ci/commit/74aaf31a50fa6d7e898e664ae907a079391fbc76)

Brand-new internal infrastructure: a CLI orchestrator (`resolve-matrix`, `run-suite`, `run-all`) with a full dependency graph of 21 `@gramio/*` packages across 5 layers. Clones repos, applies dependency overrides, runs install → build → type-check → tests per package. 9 production-like flow tests (38 cases) cover bot assembly, middleware composition, scenes lifecycle, callback+keyboard roundtrip, error handling, macros, format integration, inline queries, webhooks. Nightly schedule + manual dispatch + `repository_dispatch` trigger for cross-repo CI on package publish.

### Documentation & Skills

A massive cycle for the docs and AI tooling too:

* **`/gramio-pick-username` skill** — generates Telegram bot username candidates, validates against BotFather's rules, batch-checks t.me availability via the bundled `check-usernames.mjs` script.
* **Skill verification gates** — `bun run check:skills` and `bun run test:skills` now run on every CI push that touches `skills/**`. Every example exports `{ bot }` and has a matching runtime test driving it through `@gramio/test`.
* **UX patterns reference** — a button-first design playbook covering hero `/start`, edit-in-place navigation, breadcrumbs, toggle buttons, destructive confirm flows, loading/empty states, and the ship checklist.
* **Introspection CLI tools** — four scripts under `skills/tools/` parse installed `@gramio/*` packages to return token-efficient signatures for 169 Bot API methods, 329 Telegram types, context getters, and plugin shapes.
* **grammY migration guide** — comprehensive side-by-side code comparisons.
* **Package-manager switcher** — VitePress nav now has a global pm switcher; all `::: code-group` install blocks moved to `::: pm-add` shorthand.

---

---
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-pick-username` — Pick a Bot Username

```bash
/gramio-pick-username weather bot for Russian users
/gramio-pick-username крипто-трекер
/gramio-pick-username is @weatherly_bot free?
```

Generates candidate Telegram bot usernames that satisfy BotFather's rules (5–32 chars, `a-z0-9_`, ends in `bot`, no leading digit / leading-trailing / consecutive underscores), checks availability on `t.me` by inspecting the main CTA button text (`Start Bot` / `View Bot` = taken, `Send Message` = free), and returns a ranked shortlist. Always reminds the user to verify the finalist in `@BotFather` — a name free on `t.me` may still be reserved from a previously deleted bot.

## 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-05-31 — Bot API 10.0 Lands Ecosystem-Wide & Scenes Become Composers](/changelogs/2026-05-31)
* [2026-05-08 — Bot API 9.6, gramio 0.9, and the New Onboarding Plugin](/changelogs/2026-05-08)
* [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`.
* **CallbackData Trigger** (gramio v0.10+): pass a [`CallbackData`](/triggers/callback-query) instance to match on the chosen **`result_id`** and unpack it into a typed `context.queryData`.

### CallbackData trigger — typed `result_id` (gramio v0.10+)

Just like [`callbackQuery`](/triggers/callback-query), `chosenInlineResult` now accepts a `CallbackData` schema. Instead of matching against the inline `query`, it filters on the **`result_id`** you assigned to each result and decodes it into a fully typed `context.queryData`:

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

const card = new CallbackData("card").number("id");

// Encode the schema into each result's id
bot.inlineQuery(/cards/, (context) =>
    context.answer([
        InlineQueryResult.article(
            card.pack({ id: 42 }), // ← result_id carries the typed payload
            "Card #42",
            InputMessageContent.text("Card #42"),
            { reply_markup: new InlineKeyboard().text("Open", "open") }
        ),
    ])
);

// Decode it back when the user picks that result
bot.chosenInlineResult(card, (context) => {
    context.queryData.id; // ✅ typed as number
});
```

This keeps inline-result routing as type-safe as your callback-button routing — no manual string parsing of `result_id`.

---

---
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/gramio/classes/AllowedUpdatesFilter.md'
---
[GramIO API Reference](../../../index.md) / [gramio/dist](../index.md) / AllowedUpdatesFilter

# Class: AllowedUpdatesFilter

Defined in: gramio/index.d.ts:63

Fluent, immutable builder for the Telegram Bot API `allowed_updates` list.

Instances directly extend `Array<AllowedUpdateName>`, so they can be passed
wherever `allowedUpdates` is expected without any conversion.

## Example

```typescript
import { AllowedUpdatesFilter } from "gramio";

// All updates (opt-in types included: chat_member, message_reaction, message_reaction_count)
bot.start({ allowedUpdates: AllowedUpdatesFilter.all });

// Telegram's default set (opt-in types excluded)
bot.start({ allowedUpdates: AllowedUpdatesFilter.default });

// Explicit list
bot.start({ allowedUpdates: AllowedUpdatesFilter.only("message", "callback_query") });

// All except poll events
bot.start({ allowedUpdates: AllowedUpdatesFilter.all.except("poll", "poll_answer") });

// Default + opt-in to chat_member
bot.start({ allowedUpdates: AllowedUpdatesFilter.default.add("chat_member") });
```

## Extends

* `Array`<[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)>

## Indexable

> \[`n`: `number`]: [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

## Constructors

### Constructor

> **new AllowedUpdatesFilter**(`updates`): `AllowedUpdatesFilter`

Defined in: gramio/index.d.ts:65

**`Internal`**

use static factory methods instead

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `updates` | readonly [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[] |

#### Returns

`AllowedUpdatesFilter`

#### Overrides

`Array<AllowedUpdateName>.constructor`

## Properties

| Property | Modifier | Type | Description | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
|  `[unscopables]` | `readonly` | `object` | Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. | `Array.[unscopables]` | typescript/lib/lib.es2015.symbol.wellknown.d.ts:95 |
| `[unscopables].[iterator]?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.iterable.d.ts:76 |
| `[unscopables].[unscopables]?` | `readonly` | `boolean` | Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. | - | typescript/lib/lib.es2015.symbol.wellknown.d.ts:95 |
| `[unscopables].at?` | `public` | `boolean` | - | - | typescript/lib/lib.es2022.array.d.ts:22 |
| `[unscopables].concat?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1351 |
| `[unscopables].copyWithin?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.core.d.ts:60 |
| `[unscopables].entries?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.iterable.d.ts:81 |
| `[unscopables].every?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1438 |
| `[unscopables].fill?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.core.d.ts:49 |
| `[unscopables].filter?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1474 |
| `[unscopables].find?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.core.d.ts:27 |
| `[unscopables].findIndex?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.core.d.ts:39 |
| `[unscopables].flat?` | `public` | `boolean` | - | - | typescript/lib/lib.es2019.array.d.ts:73 |
| `[unscopables].flatMap?` | `public` | `boolean` | - | - | typescript/lib/lib.es2019.array.d.ts:62 |
| `[unscopables].forEach?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1462 |
| `[unscopables].includes?` | `public` | `boolean` | - | - | typescript/lib/lib.es2016.array.include.d.ts:23 |
| `[unscopables].indexOf?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1423 |
| `[unscopables].join?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1362 |
| `[unscopables].keys?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.iterable.d.ts:86 |
| `[unscopables].lastIndexOf?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1429 |
| `[unscopables].length?` | `public` | `boolean` | Gets or sets the length of the array. This is a number one higher than the highest index in the array. | - | typescript/lib/lib.es5.d.ts:1327 |
| `[unscopables].map?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1468 |
| `[unscopables].pop?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1340 |
| `[unscopables].push?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1345 |
| `[unscopables].reduce?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1486 |
| `[unscopables].reduceRight?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1499 |
| `[unscopables].reverse?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1367 |
| `[unscopables].shift?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1372 |
| `[unscopables].slice?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1382 |
| `[unscopables].some?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1456 |
| `[unscopables].sort?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1393 |
| `[unscopables].splice?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1402 |
| `[unscopables].toLocaleString?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1335 |
| `[unscopables].toString?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1331 |
| `[unscopables].unshift?` | `public` | `boolean` | - | - | typescript/lib/lib.es5.d.ts:1417 |
| `[unscopables].values?` | `public` | `boolean` | - | - | typescript/lib/lib.es2015.iterable.d.ts:91 |
|  `length` | `public` | `number` | Gets or sets the length of the array. This is a number one higher than the highest index in the array. | `Array.length` | typescript/lib/lib.es5.d.ts:1327 |
|  `[species]` | `readonly` | `ArrayConstructor` | - | `Array.[species]` | typescript/lib/lib.es2015.symbol.wellknown.d.ts:314 |

## Accessors

### all

#### Get Signature

> **get** `static` **all**(): `AllowedUpdatesFilter`

Defined in: gramio/index.d.ts:70

All update types, including the opt-in ones:
`chat_member`, `message_reaction`, and `message_reaction_count`.

##### Returns

`AllowedUpdatesFilter`

***

### default

#### Get Signature

> **get** `static` **default**(): `AllowedUpdatesFilter`

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

Telegram's **default** update set.

Receive all updates *except* `chat_member`, `message_reaction`, and
`message_reaction_count` — the three types that Telegram requires to be
explicitly listed in `allowed_updates`.

This matches what Telegram does when `allowed_updates` is omitted or
passed as an empty array.

##### Returns

`AllowedUpdatesFilter`

## Methods

### \[iterator]\()

> **\[iterator]**(): `ArrayIterator`<[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)>

Defined in: typescript/lib/lib.es2015.iterable.d.ts:76

Iterator

#### Returns

`ArrayIterator`<[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)>

#### Inherited from

`Array.[iterator]`

***

### add()

> **add**(...`types`): `AllowedUpdatesFilter`

Defined in: gramio/index.d.ts:100

Return a new filter with the given types **added**.
Already-present types are silently deduplicated.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`types` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[] |

#### Returns

`AllowedUpdatesFilter`

#### Example

```typescript
AllowedUpdatesFilter.default.add("chat_member", "message_reaction")
```

***

### at()

> **at**(`index`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es2022.array.d.ts:22

Returns the item located at the specified index.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `index` | `number` | The zero-based index of the desired code unit. A negative index will count back from the last item. |

#### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

#### Inherited from

`Array.at`

***

### concat()

#### Call Signature

> **concat**(...`items`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: typescript/lib/lib.es5.d.ts:1351

Combines two or more arrays.
This method returns a new array without modifying any existing arrays.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| ...`items` | `ConcatArray`<[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)>\[] | Additional arrays and/or items to add to the end of the array. |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

##### Inherited from

`Array.concat`

#### Call Signature

> **concat**(...`items`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: typescript/lib/lib.es5.d.ts:1357

Combines two or more arrays.
This method returns a new array without modifying any existing arrays.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| ...`items` | ([`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) | `ConcatArray`<[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)>)\[] | Additional arrays and/or items to add to the end of the array. |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

##### Inherited from

`Array.concat`

***

### copyWithin()

> **copyWithin**(`target`, `start`, `end?`): `this`

Defined in: typescript/lib/lib.es2015.core.d.ts:60

Returns the this object after copying a section of the array identified by start and end
to the same array starting at position target

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `target` | `number` | If target is negative, it is treated as length+target where length is the length of the array. |
| `start` | `number` | If start is negative, it is treated as length+start. If end is negative, it is treated as length+end. |
| `end?` | `number` | If not specified, length of the this object is used as its default value. |

#### Returns

`this`

#### Inherited from

`Array.copyWithin`

***

### entries()

> **entries**(): `ArrayIterator`<\[`number`, [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)]>

Defined in: typescript/lib/lib.es2015.iterable.d.ts:81

Returns an iterable of key, value pairs for every entry in the array

#### Returns

`ArrayIterator`<\[`number`, [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)]>

#### Inherited from

`Array.entries`

***

### every()

#### Call Signature

> **every**<`S`>(`predicate`, `thisArg?`): `this is S[]`

Defined in: typescript/lib/lib.es5.d.ts:1438

Determines whether all the members of an array satisfy the specified test.

##### Type Parameters

| Type Parameter |
| ------ |
| `S` *extends* [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) |

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `predicate` | (`value`, `index`, `array`) => `value is S` | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. |
| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |

##### Returns

`this is S[]`

##### Inherited from

`Array.every`

#### Call Signature

> **every**(`predicate`, `thisArg?`): `boolean`

Defined in: typescript/lib/lib.es5.d.ts:1447

Determines whether all the members of an array satisfy the specified test.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `predicate` | (`value`, `index`, `array`) => `unknown` | A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array. |
| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |

##### Returns

`boolean`

##### Inherited from

`Array.every`

***

### except()

> **except**(...`types`): `AllowedUpdatesFilter`

Defined in: gramio/index.d.ts:109

Return a new filter with the given types **removed**.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`types` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[] |

#### Returns

`AllowedUpdatesFilter`

#### Example

```typescript
AllowedUpdatesFilter.all.except("poll", "poll_answer", "chosen_inline_result")
```

***

### fill()

> **fill**(`value`, `start?`, `end?`): `this`

Defined in: typescript/lib/lib.es2015.core.d.ts:49

Changes all array elements from `start` to `end` index to a static `value` and returns the modified array

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `value` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) | value to fill array section with |
| `start?` | `number` | index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array. |
| `end?` | `number` | index to stop filling the array at. If end is negative, it is treated as length+end. |

#### Returns

`this`

#### Inherited from

`Array.fill`

***

### filter()

#### Call Signature

> **filter**<`S`>(`predicate`, `thisArg?`): `S`\[]

Defined in: typescript/lib/lib.es5.d.ts:1474

Returns the elements of an array that meet the condition specified in a callback function.

##### Type Parameters

| Type Parameter |
| ------ |
| `S` *extends* [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) |

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `predicate` | (`value`, `index`, `array`) => `value is S` | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. |
| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |

##### Returns

`S`\[]

##### Inherited from

`Array.filter`

#### Call Signature

> **filter**(`predicate`, `thisArg?`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: typescript/lib/lib.es5.d.ts:1480

Returns the elements of an array that meet the condition specified in a callback function.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `predicate` | (`value`, `index`, `array`) => `unknown` | A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. |
| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

##### Inherited from

`Array.filter`

***

### find()

#### Call Signature

> **find**<`S`>(`predicate`, `thisArg?`): `S`

Defined in: typescript/lib/lib.es2015.core.d.ts:27

Returns the value of the first element in the array where predicate is true, and undefined
otherwise.

##### Type Parameters

| Type Parameter |
| ------ |
| `S` *extends* [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) |

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `predicate` | (`value`, `index`, `obj`) => `value is S` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined. |
| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |

##### Returns

`S`

##### Inherited from

`Array.find`

#### Call Signature

> **find**(`predicate`, `thisArg?`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es2015.core.d.ts:28

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | (`value`, `index`, `obj`) => `unknown` |
| `thisArg?` | `any` |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

##### Inherited from

`Array.find`

***

### findIndex()

> **findIndex**(`predicate`, `thisArg?`): `number`

Defined in: typescript/lib/lib.es2015.core.d.ts:39

Returns the index of the first element in the array where predicate is true, and -1
otherwise.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `predicate` | (`value`, `index`, `obj`) => `unknown` | find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1. |
| `thisArg?` | `any` | If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead. |

#### Returns

`number`

#### Inherited from

`Array.findIndex`

***

### flat()

> **flat**<`A`, `D`>(`this`, `depth?`): `FlatArray`<`A`, `D`>\[]

Defined in: typescript/lib/lib.es2019.array.d.ts:73

Returns a new array with all sub-array elements concatenated into it recursively up to the
specified depth.

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `A` | - |
| `D` *extends* `number` | `1` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `this` | `A` | - |
| `depth?` | `D` | The maximum recursion depth |

#### Returns

`FlatArray`<`A`, `D`>\[]

#### Inherited from

`Array.flat`

***

### flatMap()

> **flatMap**<`U`, `This`>(`callback`, `thisArg?`): `U`\[]

Defined in: typescript/lib/lib.es2019.array.d.ts:62

Calls a defined callback function on each element of an array. Then, flattens the result into
a new array.
This is identical to a map followed by flat with depth 1.

#### Type Parameters

| Type Parameter | Default type |
| ------ | ------ |
| `U` | - |
| `This` | `undefined` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback` | (`this`, `value`, `index`, `array`) => `U` | readonly `U`\[] | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. |
| `thisArg?` | `This` | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. |

#### Returns

`U`\[]

#### Inherited from

`Array.flatMap`

***

### forEach()

> **forEach**(`callbackfn`, `thisArg?`): `void`

Defined in: typescript/lib/lib.es5.d.ts:1462

Performs the specified action for each element in an array.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callbackfn` | (`value`, `index`, `array`) => `void` | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. |
| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

#### Returns

`void`

#### Inherited from

`Array.forEach`

***

### includes()

> **includes**(`searchElement`, `fromIndex?`): `boolean`

Defined in: typescript/lib/lib.es2016.array.include.d.ts:23

Determines whether an array includes a certain element, returning true or false as appropriate.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `searchElement` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) | The element to search for. |
| `fromIndex?` | `number` | The position in this array at which to begin searching for searchElement. |

#### Returns

`boolean`

#### Inherited from

`Array.includes`

***

### indexOf()

> **indexOf**(`searchElement`, `fromIndex?`): `number`

Defined in: typescript/lib/lib.es5.d.ts:1423

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `searchElement` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) | The value to locate in the array. |
| `fromIndex?` | `number` | The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. |

#### Returns

`number`

#### Inherited from

`Array.indexOf`

***

### join()

> **join**(`separator?`): `string`

Defined in: typescript/lib/lib.es5.d.ts:1362

Adds all the elements of an array into a string, separated by the specified separator string.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `separator?` | `string` | A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma. |

#### Returns

`string`

#### Inherited from

`Array.join`

***

### keys()

> **keys**(): `ArrayIterator`<`number`>

Defined in: typescript/lib/lib.es2015.iterable.d.ts:86

Returns an iterable of keys in the array

#### Returns

`ArrayIterator`<`number`>

#### Inherited from

`Array.keys`

***

### lastIndexOf()

> **lastIndexOf**(`searchElement`, `fromIndex?`): `number`

Defined in: typescript/lib/lib.es5.d.ts:1429

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `searchElement` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) | The value to locate in the array. |
| `fromIndex?` | `number` | The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array. |

#### Returns

`number`

#### Inherited from

`Array.lastIndexOf`

***

### map()

> **map**<`U`>(`callbackfn`, `thisArg?`): `U`\[]

Defined in: typescript/lib/lib.es5.d.ts:1468

Calls a defined callback function on each element of an array, and returns an array that contains the results.

#### Type Parameters

| Type Parameter |
| ------ |
| `U` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callbackfn` | (`value`, `index`, `array`) => `U` | A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. |
| `thisArg?` | `any` | An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. |

#### Returns

`U`\[]

#### Inherited from

`Array.map`

***

### pop()

> **pop**(): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es5.d.ts:1340

Removes the last element from an array and returns it.
If the array is empty, undefined is returned and the array is not modified.

#### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

#### Inherited from

`Array.pop`

***

### push()

> **push**(...`items`): `number`

Defined in: typescript/lib/lib.es5.d.ts:1345

Appends new elements to the end of an array, and returns the new length of the array.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| ...`items` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[] | New elements to add to the array. |

#### Returns

`number`

#### Inherited from

`Array.push`

***

### reduce()

#### Call Signature

> **reduce**(`callbackfn`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es5.d.ts:1486

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callbackfn` | (`previousValue`, `currentValue`, `currentIndex`, `array`) => [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

##### Inherited from

`Array.reduce`

#### Call Signature

> **reduce**(`callbackfn`, `initialValue`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es5.d.ts:1487

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `callbackfn` | (`previousValue`, `currentValue`, `currentIndex`, `array`) => [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) |
| `initialValue` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

##### Inherited from

`Array.reduce`

#### Call Signature

> **reduce**<`U`>(`callbackfn`, `initialValue`): `U`

Defined in: typescript/lib/lib.es5.d.ts:1493

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

##### Type Parameters

| Type Parameter |
| ------ |
| `U` |

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callbackfn` | (`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |

##### Returns

`U`

##### Inherited from

`Array.reduce`

***

### reduceRight()

#### Call Signature

> **reduceRight**(`callbackfn`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es5.d.ts:1499

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callbackfn` | (`previousValue`, `currentValue`, `currentIndex`, `array`) => [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

##### Inherited from

`Array.reduceRight`

#### Call Signature

> **reduceRight**(`callbackfn`, `initialValue`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es5.d.ts:1500

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `callbackfn` | (`previousValue`, `currentValue`, `currentIndex`, `array`) => [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) |
| `initialValue` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md) |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

##### Inherited from

`Array.reduceRight`

#### Call Signature

> **reduceRight**<`U`>(`callbackfn`, `initialValue`): `U`

Defined in: typescript/lib/lib.es5.d.ts:1506

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

##### Type Parameters

| Type Parameter |
| ------ |
| `U` |

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callbackfn` | (`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |
| `initialValue` | `U` | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |

##### Returns

`U`

##### Inherited from

`Array.reduceRight`

***

### reverse()

> **reverse**(): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: typescript/lib/lib.es5.d.ts:1367

Reverses the elements in an array in place.
This method mutates the array and returns a reference to the same array.

#### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

#### Inherited from

`Array.reverse`

***

### shift()

> **shift**(): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

Defined in: typescript/lib/lib.es5.d.ts:1372

Removes the first element from an array and returns it.
If the array is empty, undefined is returned and the array is not modified.

#### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)

#### Inherited from

`Array.shift`

***

### slice()

> **slice**(`start?`, `end?`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: typescript/lib/lib.es5.d.ts:1382

Returns a copy of a section of an array.
For both start and end, a negative index can be used to indicate an offset from the end of the array.
For example, -2 refers to the second to last element of the array.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `start?` | `number` | The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0. |
| `end?` | `number` | The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array. |

#### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

#### Inherited from

`Array.slice`

***

### some()

> **some**(`predicate`, `thisArg?`): `boolean`

Defined in: typescript/lib/lib.es5.d.ts:1456

Determines whether the specified callback function returns true for any element of an array.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `predicate` | (`value`, `index`, `array`) => `unknown` | A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array. |
| `thisArg?` | `any` | An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. |

#### Returns

`boolean`

#### Inherited from

`Array.some`

***

### sort()

> **sort**(`compareFn?`): `this`

Defined in: typescript/lib/lib.es5.d.ts:1393

Sorts an array in place.
This method mutates the array and returns a reference to the same array.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `compareFn?` | (`a`, `b`) => `number` | Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order. `[11,2,22,1].sort((a, b) => a - b)` |

#### Returns

`this`

#### Inherited from

`Array.sort`

***

### splice()

#### Call Signature

> **splice**(`start`, `deleteCount?`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: typescript/lib/lib.es5.d.ts:1402

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `start` | `number` | The zero-based location in the array from which to start removing elements. |
| `deleteCount?` | `number` | The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

An array containing the elements that were deleted.

##### Inherited from

`Array.splice`

#### Call Signature

> **splice**(`start`, `deleteCount`, ...`items`): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: typescript/lib/lib.es5.d.ts:1412

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `start` | `number` | The zero-based location in the array from which to start removing elements. |
| `deleteCount` | `number` | The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. |
| ...`items` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[] | Elements to insert into the array in place of the deleted elements. |

##### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

An array containing the elements that were deleted.

##### Inherited from

`Array.splice`

***

### toArray()

> **toArray**(): [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

Defined in: gramio/index.d.ts:111

Convert to a plain `AllowedUpdateName[]` array.

#### Returns

[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[]

***

### toLocaleString()

#### Call Signature

> **toLocaleString**(): `string`

Defined in: typescript/lib/lib.es5.d.ts:1335

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

##### Returns

`string`

##### Inherited from

`Array.toLocaleString`

#### Call Signature

> **toLocaleString**(`locales`, `options?`): `string`

Defined in: typescript/lib/lib.es2015.core.d.ts:62

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `locales` | `string` | `string`\[] |
| `options?` | `NumberFormatOptions` & `DateTimeFormatOptions` |

##### Returns

`string`

##### Inherited from

`Array.toLocaleString`

***

### toString()

> **toString**(): `string`

Defined in: typescript/lib/lib.es5.d.ts:1331

Returns a string representation of an array.

#### Returns

`string`

#### Inherited from

`Array.toString`

***

### unshift()

> **unshift**(...`items`): `number`

Defined in: typescript/lib/lib.es5.d.ts:1417

Inserts new elements at the start of an array, and returns the new length of the array.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| ...`items` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[] | Elements to insert at the start of the array. |

#### Returns

`number`

#### Inherited from

`Array.unshift`

***

### values()

> **values**(): `ArrayIterator`<[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)>

Defined in: typescript/lib/lib.es2015.iterable.d.ts:91

Returns an iterable of values in the array

#### Returns

`ArrayIterator`<[`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)>

#### Inherited from

`Array.values`

***

### from()

#### Call Signature

> `static` **from**<`T`>(`arrayLike`): `T`\[]

Defined in: typescript/lib/lib.es2015.core.d.ts:70

Creates an array from an array-like object.

##### Type Parameters

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

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `arrayLike` | `ArrayLike`<`T`> | An array-like object to convert to an array. |

##### Returns

`T`\[]

##### Inherited from

`Array.from`

#### Call Signature

> `static` **from**<`T`, `U`>(`arrayLike`, `mapfn`, `thisArg?`): `U`\[]

Defined in: typescript/lib/lib.es2015.core.d.ts:78

Creates an array from an iterable object.

##### Type Parameters

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

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `arrayLike` | `ArrayLike`<`T`> | An array-like object to convert to an array. |
| `mapfn` | (`v`, `k`) => `U` | A mapping function to call on every element of the array. |
| `thisArg?` | `any` | Value of 'this' used to invoke the mapfn. |

##### Returns

`U`\[]

##### Inherited from

`Array.from`

#### Call Signature

> `static` **from**<`T`>(`iterable`): `T`\[]

Defined in: typescript/lib/lib.es2015.iterable.d.ts:99

Creates an array from an iterable object.

##### Type Parameters

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

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `iterable` | `Iterable`<`T`, `any`, `any`> | `ArrayLike`<`T`> | An iterable object to convert to an array. |

##### Returns

`T`\[]

##### Inherited from

`Array.from`

#### Call Signature

> `static` **from**<`T`, `U`>(`iterable`, `mapfn`, `thisArg?`): `U`\[]

Defined in: typescript/lib/lib.es2015.iterable.d.ts:107

Creates an array from an iterable object.

##### Type Parameters

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

##### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `iterable` | `Iterable`<`T`, `any`, `any`> | `ArrayLike`<`T`> | An iterable object to convert to an array. |
| `mapfn` | (`v`, `k`) => `U` | A mapping function to call on every element of the array. |
| `thisArg?` | `any` | Value of 'this' used to invoke the mapfn. |

##### Returns

`U`\[]

##### Inherited from

`Array.from`

***

### isArray()

> `static` **isArray**(`arg`): `arg is any[]`

Defined in: typescript/lib/lib.es5.d.ts:1518

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `arg` | `any` |

#### Returns

`arg is any[]`

#### Inherited from

`Array.isArray`

***

### of()

> `static` **of**<`T`>(...`items`): `T`\[]

Defined in: typescript/lib/lib.es2015.core.d.ts:84

Returns a new array from a set of elements.

#### Type Parameters

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

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| ...`items` | `T`\[] | A set of elements to include in the new array object. |

#### Returns

`T`\[]

#### Inherited from

`Array.of`

***

### only()

> `static` **only**(...`types`): `AllowedUpdatesFilter`

Defined in: gramio/index.d.ts:90

Create a filter with **exactly** the specified update types.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`types` | [`AllowedUpdateName`](../type-aliases/AllowedUpdateName.md)\[] |

#### Returns

`AllowedUpdatesFilter`

#### Example

```typescript
AllowedUpdatesFilter.only("message", "callback_query", "inline_query")
```

---

---
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:349

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:335

#### 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:350 |
|  `payload` | `protected` | [`TelegramAnimation`](../../../../gramio/interfaces/TelegramAnimation.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:332 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:356

Duration of the video in seconds as defined by sender

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

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

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:360

Original animation filename as defined by sender

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

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

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

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

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:354

Video height as defined by sender

##### Returns

`number`

***

### mimeType

#### Get Signature

> **get** **mimeType**(): `string`

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

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:358

Animation thumbnail as defined by sender

##### Returns

[`PhotoSize`](PhotoSize.md)

***

### width

#### Get Signature

> **get** **width**(): `number`

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

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:319

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:320 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:371

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:335

#### 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:372 |
|  `payload` | `protected` | [`TelegramAudio`](../../../../gramio/interfaces/TelegramAudio.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:332 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:374

Duration of the audio in seconds as defined by sender

##### Returns

`number`

***

### fileId

#### Get Signature

> **get** **fileId**(): `string`

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

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:380

Original filename as defined by sender

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

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

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

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

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:382

MIME type of the file as defined by sender

##### Returns

`string`

***

### performer

#### Get Signature

> **get** **performer**(): `string`

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

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:386

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:378

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:990

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:992

#### 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:991 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1002

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:998

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:1010

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:1012

#### 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:1011 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1026

Bottom color of the gradient in the RGB24 format

##### Returns

`number`

***

### rotationAngle

#### Get Signature

> **get** **rotationAngle**(): `number`

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

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:1022

Top color of the gradient in the RGB24 format

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"gradient"`

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

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:1038

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:1040

#### 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:1039 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1050

The color of the background fill in the RGB24 format

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"solid"`

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

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:1073

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:1075

#### 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:1074 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1085

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:1081

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:1093

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:1095

#### 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:1094 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1109

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:1105

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:1101

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:1117

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:1119

#### 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:1118 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1129

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:1133

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:1137

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:1141

*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:1145

*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:1125

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:1153

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:1155

#### 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:1154 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1169

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:1165

Document with the wallpaper

##### Returns

[`DocumentAttachment`](DocumentAttachment.md)

***

### isBlurred

#### Get Signature

> **get** **isBlurred**(): `true`

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

*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:1177

*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:1161

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:1202

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:1204

#### 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:1203 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1210

Day of the user's birth; 1-31

##### Returns

`number`

***

### month

#### Get Signature

> **get** **month**(): `number`

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

Month of the user's birth; 1-12

##### Returns

`number`

***

### year

#### Get Signature

> **get** **year**(): `number`

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

*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:5431

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:5435

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:5431

#### 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:4856 |
|  `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:5433 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:5437

Number of boosts added by the user

##### Returns

`number`

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

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

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<BoostAddedContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:1140

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:1177

#### 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:1180

#### 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:1142 |
| `_.derives` | `public` | `Derives` | **Deprecated** @internal. Remap generic | gramio/index.d.ts:1144 |
|  ~~`__Derives`~~ | `public` | `Derives` | **Deprecated** use `~.derives` instead @internal. Remap generic | gramio/index.d.ts:1147 |
|  `~` | `public` | `object` | - | gramio/index.d.ts:1148 |
| `~.derives` | `public` | `Derives` | **Deprecated** @internal. Remap generic | gramio/index.d.ts:1150 |
|  `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:1169 |
|  `info` | `public` | [`TelegramUser`](../interfaces/TelegramUser.md) | Bot data (filled in when calling bot.init/bot.start) | gramio/index.d.ts:1155 |
|  `options` | `readonly` | [`BotOptions`](../interfaces/BotOptions.md) | Options provided to instance | gramio/index.d.ts:1153 |
|  `updates` | `public` | [`Updates`](Updates.md) | This instance handle updates | gramio/index.d.ts:1175 |

## Methods

### callbackQuery()

> **callbackQuery**<`Trigger`, `TOptions`>(`trigger`, `handler`, `options?`): `this`

Defined in: gramio/index.d.ts:1480

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:1482

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()

#### Call Signature

> **command**<`TOptions`>(`command`, `handler`, `options?`): `Bot`<`Errors`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:1559

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

`Bot`<`Errors`, `Derives`, `Macros`>

##### Examples

```ts
new Bot().command("start", async (context) => {
    return context.send(`You message is /start ${context.args}`);
});
```

```ts
// With metadata — description will be synced via syncCommands()
new Bot().command("start", {
    description: "Start the bot",
    locales: { ru: "Запустить бота" },
}, (context) => context.send("Hello!"));
```

#### Call Signature

> **command**<`TOptions`>(`command`, `meta`, `handler`, `options?`): `Bot`<`Errors`, `Derives`, `Macros`>

Defined in: gramio/index.d.ts:1562

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`> |
| `meta` | [`CommandMeta`](../interfaces/CommandMeta.md) |
| `handler` | (`context`) => `unknown` |
| `options?` | `TOptions` |

##### Returns

`Bot`<`Errors`, `Derives`, `Macros`>

##### Examples

```ts
new Bot().command("start", async (context) => {
    return context.send(`You message is /start ${context.args}`);
});
```

```ts
// With metadata — description will be synced via syncCommands()
new Bot().command("start", {
    description: "Start the bot",
    locales: { ru: "Запустить бота" },
}, (context) => context.send("Hello!"));
```

***

### decorate()

#### Call Signature

> **decorate**<`Value`>(`value`): `Bot`<`Errors`, `Derives` & `object`, `Macros`>

Defined in: gramio/index.d.ts:1272

##### 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:1277

##### 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:1266

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:1269

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`]> & [`GetDerives`](../../../contexts/type-aliases/GetDerives.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:1203

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:1206

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:1239

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:1442

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:1445

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:1581

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:1537

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:1597

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:1520

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:1301

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:1303

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:1400

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`>]> & [`GetDerives`](../../../contexts/type-aliases/GetDerives.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `CompatibleUpdates`<`Bot`<`Errors`, `Derives`, `Macros`>, `Narrowing`>> & `Derives`\[`"global"`] & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**(`filter`, `handler`): `this`

Defined in: gramio/index.d.ts:1402

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:1404

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`]> & [`GetDerives`](../../../contexts/type-aliases/GetDerives.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `T`> & `Narrowing`> |

##### Returns

`this`

#### Call Signature

> **on**<`T`>(`updateName`, `filter`, `handler`): `this`

Defined in: gramio/index.d.ts:1406

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:1408

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:1397

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:1398

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:1252

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:1253

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:1373

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:1374

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:1380

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:1381

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:1324

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, bot }) => {
        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:1345

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, bot }) => {
        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:1366

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:1367

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:1456

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:1612

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:1575

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"`> & [`GetDerives`](../../../contexts/type-aliases/GetDerives.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `"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"`> & [`GetDerives`](../../../contexts/type-aliases/GetDerives.md)<`Bot`<`Errors`, `Derives`, `Macros`>, `"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:1616

Stops receiving events via long-polling or webhook

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `timeout?` | `number` |

#### Returns

`Promise`<`void`>

***

### syncCommands()

> **syncCommands**(`options?`): `Promise`<`void`>

Defined in: gramio/index.d.ts:1593

Sync registered command metadata with the Telegram API.

Groups commands by `{scope, language_code}` and calls `setMyCommands` for each group.
When a `storage` is provided, hashes each payload and skips unchanged groups.

#### Parameters

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

#### Returns

`Promise`<`void`>

#### Example

```ts
bot.onStart(() => bot.syncCommands());
```

***

### use()

> **use**(`handler`): `this`

Defined in: gramio/index.d.ts:1410

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:1222

This object represents a bot command

## Constructors

### Constructor

> **new BotCommand**(`payload`): `BotCommand`

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

#### 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:1223 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1228

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:1230

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:1234

This object represents the bot's description.

## Constructors

### Constructor

> **new BotDescription**(`payload`): `BotDescription`

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

#### 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:1235 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1240

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:1244

This object represents the bot's short description.

## Constructors

### Constructor

> **new BotShortDescription**(`payload`): `BotShortDescription`

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

#### 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:1245 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1250

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:1258

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:1260

#### 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:1259 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1303

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:1311

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:1283

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:1275

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:1279

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:1291

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:1287

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:1295

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:1299

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:1323

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:1270

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:1266

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:1315

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:1319

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:1307

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:1331

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:1333

#### 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:1332 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1355

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:1351

Date the connection was established in Unix time

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `string`

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

Unique identifier of the business connection

##### Returns

`string`

***

### isEnabled

#### Get Signature

> **get** **isEnabled**(): `boolean`

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

True, if the connection is active

##### Returns

`boolean`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

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

Business account user that created the business connection

##### Returns

[`User`](User.md)

***

### userChatId

#### Get Signature

> **get** **userChatId**(): `number`

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

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:5449

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:5453

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:5449

#### 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:4856 |
|  `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:5451 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1355

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:1351

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:1339

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:1359

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:1343

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:1347

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:5407

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:1367

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:1369

#### 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:1368 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1379

*Optional*. Message text of the business intro

##### Returns

`string`

***

### sticker

#### Get Signature

> **get** **sticker**(): [`StickerAttachment`](StickerAttachment.md)

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

*Optional*. Sticker of the business intro

##### Returns

[`StickerAttachment`](StickerAttachment.md)

***

### title

#### Get Signature

> **get** **title**(): `string`

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

*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:1391

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:1393

#### 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:1392 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1399

Address of the business

##### Returns

`string`

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

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

*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:1407

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:1409

#### 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:1408 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1413

Unique identifier of the business connection

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

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

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:1417

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:5465

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:5469

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:5465

#### 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:4856 |
|  `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:5467 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1413

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:1415

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:1417

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:5407

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:1423

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

## Constructors

### Constructor

> **new BusinessOpeningHours**(`payload`): `BusinessOpeningHours`

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

#### 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:1424 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1431

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:1429

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:1439

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:1441

#### 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:1440 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1451

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:1447

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:1455

A placeholder, currently holds no information.

## Constructors

### Constructor

> **new CallbackGame**(`payload`): `CallbackGame`

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

#### 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:1456 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3310

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:3312

#### 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:3311 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3334

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:3339

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:3340

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `data` | `string` |

##### Returns

`void`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

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

Sender

##### Returns

[`User`](User.md)

***

### gameShortName

#### Get Signature

> **get** **gameShortName**(): `string`

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

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:3316

Unique identifier for this query

##### Returns

`string`

***

### inlineMessageId

#### Get Signature

> **get** **inlineMessageId**(): `string`

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

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:3324

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:3320

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:5481

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:5484

#### 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:5481

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:5483 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4990

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

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

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:3334

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:3339

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:3340

##### 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:3318

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:3345

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:3316

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:3329

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:5492

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:5503

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:3320

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:4992

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### answer()

> **answer**(`params?`): `Promise`<`true`>

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

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:5511

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:5513

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:5407

#### 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:5519

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:5523

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:5521

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:5527

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:5517

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:5068

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:5507

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:5509

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:5505

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:5486

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:5498

Checks if the query has `queryPayload` property

#### Returns

`this is Require<CallbackQueryContext<Bot>, "queryPayload">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5525

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:5028

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:5066

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:597

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:599

#### 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:598 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:621

*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:605

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:633

*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:629

*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:625

*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:613

*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:609

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:617

*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:5394

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)
* [`ManagedBotCreatedContext`](ManagedBotCreatedContext.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)
* [`PollOptionAddedContext`](PollOptionAddedContext.md)
* [`PollOptionDeletedContext`](PollOptionDeletedContext.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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4990

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### ~~createActionController()~~

> **createActionController**(`action`, `params?`): `ChatActionController`<`Bot`>

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

#### 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:5068

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5028

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:5066

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:3349

Represents the rights of an administrator in a chat.

## Constructors

### Constructor

> **new ChatAdministratorRights**(`payload`): `ChatAdministratorRights`

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

#### 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: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`

## Methods

### canChangeInfo()

> **canChangeInfo**(): `boolean`

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

`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:3359

`true`, if the administrator can delete messages of other users

#### Returns

`boolean`

***

### canDeleteStories()

> **canDeleteStories**(): `boolean`

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

`true`, if the administrator can delete stories posted by other users; channels only

#### Returns

`boolean`

***

### canEditMessages()

> **canEditMessages**(): `boolean`

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

`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:3379

`true`, if the administrator can edit stories posted by other users; channels only

#### Returns

`boolean`

***

### canInviteUsers()

> **canInviteUsers**(): `boolean`

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

`true`, if the user is allowed to invite new users to the chat

#### Returns

`boolean`

***

### canManageChat()

> **canManageChat**(): `boolean`

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

`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:3385

`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:3387

`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:3383

`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:3361

`true`, if the administrator can manage video chats

#### Returns

`boolean`

***

### canPinMessages()

> **canPinMessages**(): `boolean`

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

`true`, if the user is allowed to pin messages; groups and supergroups only

#### Returns

`boolean`

***

### canPostMessages()

> **canPostMessages**(): `boolean`

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

`true`, if the administrator can post in the channel; channels only

#### Returns

`boolean`

***

### canPostStories()

> **canPostStories**(): `boolean`

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

`true`, if the administrator can post stories in the channel; channels only

#### Returns

`boolean`

***

### canPromoteMembers()

> **canPromoteMembers**(): `boolean`

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

`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:3363

`true`, if the administrator can restrict, ban or unban chat members

#### Returns

`boolean`

***

### isAnonymous()

> **isAnonymous**(): `boolean`

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

`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:1485

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:1487

#### 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:1486 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1493

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:5539

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:5542

#### 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:5539

#### 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:4856 |
|  `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:5541 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:5544

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatBackgroundSetContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:3440

This object contains information about a chat boost.

## Constructors

### Constructor

> **new ChatBoost**(`payload`): `ChatBoost`

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

#### 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:3441 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3448

Point in time (Unix timestamp) when the chat was boosted

##### Returns

`number`

***

### expirationDate

#### Get Signature

> **get** **expirationDate**(): `number`

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

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:3446

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:3452

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:1497

This object represents a service message about a user boosting a chat.

## Constructors

### Constructor

> **new ChatBoostAdded**(`payload`): `ChatBoostAdded`

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

#### 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:1498 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1503

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:5556

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:5559

#### 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:5556

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:5558 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3480

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:4990

##### 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:3478

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:4989

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clone()

> **clone**(`options?`): `ChatBoostContext`

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

#### 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:5068

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5028

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:5066

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:3456

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:3458

#### 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:3457 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3462

Chat which was boosted

##### Returns

[`Chat`](Chat.md)

***

### id

#### Get Signature

> **get** **id**(): `string`

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

Unique identifier of the boost

##### Returns

`string`

***

### removeDate

#### Get Signature

> **get** **removeDate**(): `number`

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

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:3468

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:3430

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:3432

#### 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:3431 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3434

Source of the boost, always `gift_code`

##### Returns

`"gift_code"`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

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

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:3426

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:3391

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:3393

#### 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:3392 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3396

##### Returns

`number`

***

### prizeStarCount

#### Get Signature

> **get** **prizeStarCount**(): `number`

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

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:3395

Source of the boost, always `giveaway`

##### Returns

`"giveaway"`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

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

User that boosted the chat

##### Returns

[`User`](User.md)

## Methods

### is()

> **is**<`T`>(`source`): `this is ChatBoostSourceMapping[T]`

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

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:3400

`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:3406

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:3408

#### 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:3407 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3410

Source of the boost, always `premium`

##### Returns

`"premium"`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

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

User that boosted the chat

##### Returns

[`User`](User.md)

## Methods

### is()

> **is**<`T`>(`source`): `this is ChatBoostSourceMapping[T]`

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

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:3472

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:3474

#### 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:3473 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3480

Information about the chat boost

##### Returns

[`ChatBoost`](ChatBoost.md)

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

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

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:5224

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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | [`NodeMixin`](NodeMixin.md).[`isTopicMessage`](NodeMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4870 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4895

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:4889

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:4893

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:4897

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:4874

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:5074

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`id`](NodeMixin.md#id)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

*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:4883

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:4891

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:4992

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`threadId`](NodeMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

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

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:5204

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:5206

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4905

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:4901

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:4899

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:4903

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:3628

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:3630

#### 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:3629 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3668

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:3806

##### Returns

[`AcceptedGiftTypes`](AcceptedGiftTypes.md)

***

### activeUsernames

#### Get Signature

> **get** **activeUsernames**(): `string`\[]

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

*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:3708

*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:3712

*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:3732

*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:3684

*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:3688

*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:3692

*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:3696

*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:3805

##### Returns

`boolean`

***

### canSendPaidMedia

#### Get Signature

> **get** **canSendPaidMedia**(): `true`

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

*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:3804

*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:3810

*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:3752

*Optional*. Description, for groups, supergroups and channel chats

##### Returns

`string`

***

### emojiStatusCustomEmojiId

#### Get Signature

> **get** **emojiStatusCustomEmojiId**(): `string`

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

*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:3728

*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:3652

*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:3826

*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:3780

*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:3784

*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:3736

*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:3788

*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:3740

*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:3792

*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:3636

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:3756

*Optional*. Primary invite link, for groups, supergroups and channel chats

##### Returns

`string`

***

### isDirectMessages

#### Get Signature

> **get** **isDirectMessages**(): `true`

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

*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:3660

*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:3748

*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:3744

*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:3656

*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:3814

*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:3818

*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:3672

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:3776

*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:3834

*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:3704

*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:3764

*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:3700

*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:3676

*Optional*. Chat photo

##### Returns

[`ChatPhoto`](ChatPhoto.md)

***

### pinnedMessage

#### Get Signature

> **get** **pinnedMessage**(): [`Message`](Message.md)

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

*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:3716

*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:3720

*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:3822

*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:3768

*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:3796

*Optional*. For supergroups, name of the group sticker set

##### Returns

`string`

***

### title

#### Get Signature

> **get** **title**(): `string`

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

*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:3640

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:3830

*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:3772

*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:3648

*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:5246

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:4856 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4870 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4895

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:4889

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:4893

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:4897

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:4874

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:4887

*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:4883

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:4891

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:5250

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:5252

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:5248

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:4872

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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4905

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:4901

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:4899

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:4903

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:5254

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:3838

Represents an invite link for a chat.

## Constructors

### Constructor

> **new ChatInviteLink**(`payload`): `ChatInviteLink`

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

#### 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:3839 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3865

`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:3849

Creator of the link

##### Returns

[`User`](User.md)

***

### expireDate

#### Get Signature

> **get** **expireDate**(): `number`

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

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:3847

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:3863

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:3851

Invite link name

##### Returns

`string`

***

### pendingJoinRequestCount

#### Get Signature

> **get** **pendingJoinRequestCount**(): `number`

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

Number of pending join requests created using this link

##### Returns

`number`

## Methods

### isPrimary()

> **isPrimary**(): `boolean`

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

`true`, if the link is primary

#### Returns

`boolean`

***

### isRevoked()

> **isRevoked**(): `boolean`

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

`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:3871

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:3873

#### 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:3872 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3885

Bio of the user

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

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

Chat to which the request was sent

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

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

Date the request was sent in Unix time

##### Returns

`number`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

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

User that sent the join request

##### Returns

[`User`](User.md)

***

### inviteLink

#### Get Signature

> **get** **inviteLink**(): [`ChatInviteLink`](ChatInviteLink.md)

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

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:3881

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:5575

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:5578

#### 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:5575

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:5577 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3885

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:4895

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:3877

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:4893

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:4897

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:3883

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:3879

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:3887

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:4887

*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:4883

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:4891

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:4992

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

***

### userChatId

#### Get Signature

> **get** **userChatId**(): `number`

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

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:5580

Approves chat join request

#### Returns

`Promise`<`true`>

***

### clone()

> **clone**(`options?`): `ChatJoinRequestContext`

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

#### 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:5396

#### 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:5250

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:5582

Declines chat join request

#### Returns

`Promise`<`true`>

***

### editInviteLink()

> **editInviteLink**(`link`, `params?`): `Promise`<[`TelegramChatInviteLink`](../../../../gramio/interfaces/TelegramChatInviteLink.md)>

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

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:5248

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:5068

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:4872

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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4905

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:4901

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:4899

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:4903

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5028

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:5066

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:3484

Represents a location to which a chat is connected.

## Constructors

### Constructor

> **new ChatLocation**(`payload`): `ChatLocation`

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

#### 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:3485 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3492

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:3490

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:3899

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:3901

#### 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:3900 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3909

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:3907

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:3997

Tag of the member; for members and restricted members

##### Returns

`string`

***

### untilDate

#### Get Signature

> **get** **untilDate**(): `number`

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

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:3905

Information about the user

##### Returns

[`User`](User.md)

## Methods

### canAddWebPagePreviews()

> **canAddWebPagePreviews**(): `boolean`

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

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:3923

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:3972

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:3948

Administrators only.
`true`, if the administrator can delete messages of other users

#### Returns

`boolean`

***

### canDeleteStories()

> **canDeleteStories**(): `any`

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

`true`, if the administrator can delete stories posted by other users; channels only

#### Returns

`any`

***

### canEditMessages()

> **canEditMessages**(): `boolean`

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

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:3987

`true`, if the administrator can edit stories posted by other users; channels only

#### Returns

`any`

***

### canEditTag()

> **canEditTag**(): `boolean`

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

`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:3977

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:3931

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:3993

`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:3995

`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:3991

`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:3953

Administrators only.
`true`, if the administrator can manage video chats

#### Returns

`boolean`

***

### canPinMessages()

> **canPinMessages**(): `boolean`

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

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:3937

Administrators only.
`true`, if the administrator can post in the channel;
channels only

#### Returns

`boolean`

***

### canPostStories()

> **canPostStories**(): `any`

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

`true`, if the administrator can post stories in the channel; channels only

#### Returns

`any`

***

### canPromoteMembers()

> **canPromoteMembers**(): `boolean`

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

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:3958

Administrators only.
`true`, if the administrator can restrict, ban or unban chat members

#### Returns

`boolean`

***

### canSendAudios()

> **canSendAudios**(): `boolean`

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

`true`, if the user is allowed to send audios

#### Returns

`boolean`

***

### canSendDocuments()

> **canSendDocuments**(): `boolean`

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

`true`, if the user is allowed to send documents

#### Returns

`boolean`

***

### canSendMessages()

> **canSendMessages**(): `boolean`

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

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:4030

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:4016

`true`, if the user is allowed to send photos

#### Returns

`boolean`

***

### canSendPolls()

> **canSendPolls**(): `boolean`

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

Restricted only. `true`, if the user is allowed to send polls

#### Returns

`boolean`

***

### canSendVideoNotes()

> **canSendVideoNotes**(): `boolean`

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

`true`, if the user is allowed to send video notes

#### Returns

`boolean`

***

### canSendVideos()

> **canSendVideos**(): `boolean`

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

`true`, if the user is allowed to send videos

#### Returns

`boolean`

***

### canSendVoiceNotes()

> **canSendVoiceNotes**(): `boolean`

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

`true`, if the user is allowed to send voice notes

#### Returns

`boolean`

***

### isAnonymous()

> **isAnonymous**(): `boolean`

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

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:4004

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:5599

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:5602

#### 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:5599

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:5601 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4895

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:4051

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:4893

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:4897

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:4059

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:4055

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:5074

##### 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:4071

*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:4067

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:4063

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:4887

*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:4883

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:4891

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:4992

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

***

### viaChatFolderInviteLink

#### Get Signature

> **get** **viaChatFolderInviteLink**(): `boolean`

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

*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:4075

*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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:5604

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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4905

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:4901

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:4899

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:4903

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5260

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)
* [`ManagedBotCreatedContext`](ManagedBotCreatedContext.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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | [`NodeMixin`](NodeMixin.md).[`isTopicMessage`](NodeMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4870 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4895

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:4889

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:4893

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:4897

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:4874

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:5074

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`id`](NodeMixin.md#id)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

*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:4883

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:4891

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:4992

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`threadId`](NodeMixin.md#threadid)

## Methods

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

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

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:5218

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:5204

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:5206

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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

***

### hasFrom()

> **hasFrom**(): this is Require\<ChatMemberControlMixin\<Bot>, "from" | "senderId">

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

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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4905

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:4901

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:4899

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:4903

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5264

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:4043

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:4045

#### 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:4044 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4051

Chat the user belongs to

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

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

Date the change was done in Unix time

##### Returns

`number`

***

### from

#### Get Signature

> **get** **from**(): [`User`](User.md)

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

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:4071

*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:4067

New information about the chat member

##### Returns

[`ChatMember`](ChatMember.md)

***

### oldChatMember

#### Get Signature

> **get** **oldChatMember**(): [`ChatMember`](ChatMember.md)

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

Previous information about the chat member

##### Returns

[`ChatMember`](ChatMember.md)

***

### viaChatFolderInviteLink

#### Get Signature

> **get** **viaChatFolderInviteLink**(): `boolean`

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

*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:4075

*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:1511

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:1513

#### 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:1512 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1519

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:5616

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:5620

#### 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:5616

#### 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:4856 |
|  `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:5618 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:5622

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:5624

The new owner of the chat

##### Returns

[`User`](User.md)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

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

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:1527

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:1529

#### 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:1528 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1535

*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:5636

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:5640

#### 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:5636

#### 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:4856 |
|  `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:5638 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:5642

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:5644

*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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:3500

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:3502

#### 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:3501 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3544

*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:3548

*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:3562

*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:3552

*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:3560

*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:3556

*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:3512

*Optional*. *True*, if the user is allowed to send audios

##### Returns

`boolean`

***

### canSendDocuments

#### Get Signature

> **get** **canSendDocuments**(): `boolean`

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

*Optional*. *True*, if the user is allowed to send documents

##### Returns

`boolean`

***

### canSendMessages

#### Get Signature

> **get** **canSendMessages**(): `boolean`

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

*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:3540

*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:3520

*Optional*. *True*, if the user is allowed to send photos

##### Returns

`boolean`

***

### canSendPolls

#### Get Signature

> **get** **canSendPolls**(): `boolean`

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

*Optional*. *True*, if the user is allowed to send polls

##### Returns

`boolean`

***

### canSendVideoNotes

#### Get Signature

> **get** **canSendVideoNotes**(): `boolean`

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

*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:3524

*Optional*. *True*, if the user is allowed to send videos

##### Returns

`boolean`

***

### canSendVoiceNotes

#### Get Signature

> **get** **canSendVoiceNotes**(): `boolean`

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

*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:3566

This object represents a chat photo.

## Constructors

### Constructor

> **new ChatPhoto**(`payload`): `ChatPhoto`

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

#### 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:3567 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3587

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:3593

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:3576

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:3582

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:5280

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:4856 |
|  `payload` | `public` | `Record`<`string`, `any`> | [`TargetMixin`](TargetMixin.md).[`payload`](TargetMixin.md#payload) | contexts/index.d.ts:4870 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4895

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:4889

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:4893

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:4897

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:4874

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:4887

*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:4883

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:4891

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:5282

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:4872

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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4905

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:4901

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:4899

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:4903

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:5284

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:1539

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:1541

#### 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:1540 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1547

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:1553

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:1545

Identifier of the request

##### Returns

`number`

***

### title

#### Get Signature

> **get** **title**(): `string`

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

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:1551

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:5656

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:5660

#### 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:5656

#### 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:4856 |
|  `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:5658 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:5670

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### requestId

#### Get Signature

> **get** **requestId**(): `number`

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

Identifier of the request

##### Returns

`number`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:5664

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:5666

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:3234

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:3061

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:5668

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:1596

Describes a checklist.

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

## Constructors

### Constructor

> **new Checklist**(`payload`): `Checklist`

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

#### 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:1597 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### othersCanAddTasks

#### Get Signature

> **get** **othersCanAddTasks**(): `true`

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

*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:1619

*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:1611

List of tasks in the checklist

##### Returns

[`ChecklistTask`](ChecklistTask.md)\[]

***

### title

#### Get Signature

> **get** **title**(): `string`

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

Title of the checklist

##### Returns

`string`

***

### titleEntities

#### Get Signature

> **get** **titleEntities**(): [`MessageEntity`](MessageEntity.md)\[]

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

*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:1561

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:1563

#### 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:1562 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### completedByChat

#### Get Signature

> **get** **completedByChat**(): [`Chat`](Chat.md)

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

*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:1580

*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:1588

*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:1568

Unique identifier of the task

##### Returns

`number`

***

### text

#### Get Signature

> **get** **text**(): `string`

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

Text of the task

##### Returns

`string`

***

### textEntities

#### Get Signature

> **get** **textEntities**(): [`MessageEntity`](MessageEntity.md)\[]

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

*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:1627

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:1629

#### 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:1628 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### checklistMessage

#### Get Signature

> **get** **checklistMessage**(): [`Message`](Message.md)

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

*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:1638

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:5682

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:5686

#### 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:5682

#### 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:4856 |
|  `event` | `public` | [`TelegramChecklistTasksAdded`](../../../../gramio/interfaces/TelegramChecklistTasksAdded.md) | - | - | contexts/index.d.ts:5685 |
|  `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:5684 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:5690

*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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:5694

List of tasks added to the checklist

##### Returns

[`ChecklistTask`](ChecklistTask.md)\[]

***

### text

#### Get Signature

> **get** **text**(): `string`

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

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChecklistTasksAddedContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:1646

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:1648

#### 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:1647 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### checklistMessage

#### Get Signature

> **get** **checklistMessage**(): [`Message`](Message.md)

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

*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:1657

*Optional*. Identifiers of the tasks that were marked as done

##### Returns

`number`\[]

***

### markedAsNotDoneTaskIds

#### Get Signature

> **get** **markedAsNotDoneTaskIds**(): `number`\[]

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

*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:5706

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:5710

#### 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:5706

#### 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:4856 |
|  `event` | `public` | [`TelegramChecklistTasksDone`](../../../../gramio/interfaces/TelegramChecklistTasksDone.md) | - | - | contexts/index.d.ts:5709 |
|  `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:5708 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:5714

*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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### markedAsDoneTaskIds

#### Get Signature

> **get** **markedAsDoneTaskIds**(): `number`\[]

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

*Optional*. Identifiers of the tasks that were marked as done

##### Returns

`number`\[]

***

### markedAsNotDoneTaskIds

#### Get Signature

> **get** **markedAsNotDoneTaskIds**(): `number`\[]

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

*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:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<ChecklistTasksDoneContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:4083

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:4085

#### 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:4084 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4091

The user that chose the result

##### Returns

[`User`](User.md)

***

### inlineMessageId

#### Get Signature

> **get** **inlineMessageId**(): `string`

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

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:4095

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:4103

The query that was used to obtain the result

##### Returns

`string`

***

### resultId

#### Get Signature

> **get** **resultId**(): `string`

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

The unique identifier for the result that was chosen

##### Returns

`string`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

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

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:5737

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:5740

#### 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:5737

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:5739 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4990

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

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

##### 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:4091

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:4101

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:4095

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:4103

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:4089

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:4093

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:4992

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clone()

> **clone**(`options?`): `ChosenInlineResultContext`

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

#### 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:5396

#### 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:5748

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:5752

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:5750

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:5756

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:5746

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:5068

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:5744

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:5742

Checks if the result has `location` property

#### Returns

`this is Require<ChosenInlineResultContext<Bot>, "location">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5754

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:5028

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:5066

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:5406

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)
* [`ManagedBotContext`](ManagedBotContext.md)
* [`ManagedBotCreatedContext`](ManagedBotCreatedContext.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)
* [`PollOptionAddedContext`](PollOptionAddedContext.md)
* [`PollOptionDeletedContext`](PollOptionDeletedContext.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:4856 |
|  `payload` | `public` | `Options`\[`"payload"`] | The raw data that is used for this Context | - | contexts/index.d.ts:5403 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:5407

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `Options` |

#### Returns

`C`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:161

#### 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 |
| `~.commandsMeta` | `Map`<`string`, `unknown`> | - | composer/index.d.ts:157 |
| `~.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:159 |
| `~.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:192

#### 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:180

#### 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:211

#### Returns

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

***

### decorate()

#### Call Signature

> **decorate**<`D`>(`values`): `Composer`<`TIn`, `TOut` & `D`, `TExposed`>

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

##### 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:168

##### 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:174

##### 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:175

##### 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:188

#### 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:194

#### 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:183

#### 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:193

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `fn` | (`composer`) => `void` |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### guard()

#### Call Signature

> **guard**<`S`>(`predicate`): `Composer`<`TIn`, `S`, `TExposed`>

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

##### Type Parameters

| Type Parameter |
| ------ |
| `S` *extends* `object` |

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | (`context`) => `context is S` |

##### Returns

`Composer`<`TIn`, `S`, `TExposed`>

#### Call Signature

> **guard**(`predicate`, ...`middleware`): `Composer`<`TIn`, `TOut`, `TExposed`>

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

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `predicate` | (`context`) => `boolean` | `Promise`<`boolean`> |
| ...`middleware` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`>\[] |

##### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### inspect()

> **inspect**(): [`MiddlewareInfo`](../interfaces/MiddlewareInfo.md)\[]

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

#### Returns

[`MiddlewareInfo`](../interfaces/MiddlewareInfo.md)\[]

***

### invalidate()

> **invalidate**(): `void`

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

#### Returns

`void`

***

### lazy()

> **lazy**(`factory`): `Composer`<`TIn`, `TOut`, `TExposed`>

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

#### 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:164

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:166

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:186

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`ErrorHandler`](../type-aliases/ErrorHandler.md)<`TOut`> |

#### Returns

`Composer`<`TIn`, `TOut`, `TExposed`>

***

### registeredEvents()

> **registeredEvents**(): `Set`<`string`>

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

Returns a Set of all event names registered via `.on()` and event-specific `.derive()`.

Useful for introspecting which update types the middleware chain handles,
e.g. to auto-derive `allowed_updates` for the Telegram Bot API.

#### Returns

`Set`<`string`>

#### Example

```typescript
composer.on("message", handler);
composer.on(["callback_query", "inline_query"], handler);
composer.registeredEvents(); // Set {"message", "callback_query", "inline_query"}
```

***

### route()

#### Call Signature

> **route**<`K`>(`router`, `builder`): `Composer`<`TIn`, `TOut`, `TExposed`>

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

##### 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:182

##### 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:212

#### 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:184

#### 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:210

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`TraceHandler`](../type-aliases/TraceHandler.md) |

#### Returns

`this`

***

### use()

#### Call Signature

> **use**(`handler`): `this`

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

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | [`Middleware`](../type-aliases/Middleware.md)<`TOut`> |

##### Returns

`this`

#### Call Signature

> **use**<`Patch`>(`handler`): `this`

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

##### 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:173

##### 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:187

#### 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:390

This object represents a phone contact.

## Extended by

* [`ContactAttachment`](ContactAttachment.md)

## Constructors

### Constructor

> **new Contact**(`payload`): `Contact`

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

#### 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:391 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:398

Contact's first name

##### Returns

`string`

***

### lastName

#### Get Signature

> **get** **lastName**(): `string`

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

Contact's last name

##### Returns

`string`

***

### phoneNumber

#### Get Signature

> **get** **phoneNumber**(): `string`

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

Contact's phone number

##### Returns

`string`

***

### userId

#### Get Signature

> **get** **userId**(): `number`

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

Contact's user identifier in Telegram

##### Returns

`number`

***

### vCard

#### Get Signature

> **get** **vCard**(): `string`

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

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:408

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:392

#### 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:409 |
|  `payload` | [`TelegramContact`](../../../../gramio/interfaces/TelegramContact.md) | [`Contact`](Contact.md).[`payload`](Contact.md#payload) | contexts/index.d.ts:391 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:398

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:400

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:396

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:402

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:404

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:4855

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)
* [`ManagedBotContext`](ManagedBotContext.md)
* [`ManagedBotCreatedContext`](ManagedBotCreatedContext.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)
* [`PollOptionAddedContext`](PollOptionAddedContext.md)
* [`PollOptionDeletedContext`](PollOptionDeletedContext.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:4860

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ContextOptions`<`Bot`> |

#### Returns

`Context`<`Bot`>

## Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
|  `bot` | `public` | `Bot` | contexts/index.d.ts:4856 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:5768

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:5771

#### 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:5768

#### 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:4856 |
|  `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:5770 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<DeleteChatPhotoContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:1665

This object represents an animated emoji that displays a random value.

## Constructors

### Constructor

> **new Dice**(`payload`): `Dice`

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

#### 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:1666 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1671

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:1678

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:1686

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:1688

#### 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:1687 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### areDirectMessagesEnabled

#### Get Signature

> **get** **areDirectMessagesEnabled**(): `boolean`

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

*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:1697

*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:5783

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:5787

#### 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:5783

#### 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:4856 |
|  `event` | `public` | [`TelegramDirectMessagePriceChanged`](../../../../gramio/interfaces/TelegramDirectMessagePriceChanged.md) | - | - | contexts/index.d.ts:5786 |
|  `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:5785 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:5791

*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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:5795

*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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<DirectMessagePriceChangedContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:1705

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:1707

#### 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:1706 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1713

Unique identifier of the topic

##### Returns

`number`

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

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

*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:418

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:335

#### 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:419 |
|  `payload` | `protected` | [`TelegramDocument`](../../../../gramio/interfaces/TelegramDocument.md) | - | - | [`FileAttachment`](FileAttachment.md).[`payload`](FileAttachment.md#payload) | contexts/index.d.ts:332 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:337

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:423

Original filename as defined by sender

##### Returns

`string`

***

### fileSize

#### Get Signature

> **get** **fileSize**(): `number`

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

File size

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

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

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:425

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:421

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:5416

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:4856 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:5413

##### Returns

[`Attachment`](Attachment.md)

## Methods

### download()

#### Call Signature

> **download**(): `Promise`<`ArrayBuffer`>

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

Downloads attachment

##### Returns

`Promise`<`ArrayBuffer`>

#### Call Signature

> **download**(`path`): `Promise`<`string`>

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

Downloads attachment

##### Parameters

| Parameter | Type |
| ------ | ------ |
| `path` | `string` |

##### Returns

`Promise`<`string`>

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:2380

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:2382

#### 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:2381 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2390

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:2392

Base64-encoded data hash for data authentication

##### Returns

`string`

***

### secret

#### Get Signature

> **get** **secret**(): `string`

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

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:2429

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:2431

#### 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:2430 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2448

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:2452

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:2459

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:2466

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:2492

Base64-encoded element hash for using in `PassportElementErrorUnspecified`

##### Returns

`string`

***

### phoneNumber

#### Get Signature

> **get** **phoneNumber**(): `string`

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

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:2472

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:2479

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:2488

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:2440

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:219

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:225

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `handler` | (`event`) => `Promise`<`unknown`> |

#### Returns

`EventQueue`<`T`>

## Accessors

### isActive

#### Get Signature

> **get** **isActive**(): `boolean`

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

##### Returns

`boolean`

***

### pending

#### Get Signature

> **get** **pending**(): `number`

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

##### Returns

`number`

***

### queued

#### Get Signature

> **get** **queued**(): `number`

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

##### Returns

`number`

## Methods

### add()

> **add**(`event`): `void`

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

#### Parameters

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

#### Returns

`void`

***

### addBatch()

> **addBatch**(`events`): `void`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `events` | `T`\[] |

#### Returns

`void`

***

### onIdle()

> **onIdle**(): `Promise`<`void`>

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

#### Returns

`Promise`<`void`>

***

### stop()

> **stop**(`timeout?`): `Promise`<`void`>

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

#### 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:2009

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:2011

#### 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:2010 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2024

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:2026

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:2017

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:2022

##### Returns

[`Checklist`](Checklist.md)

***

### contact

#### Get Signature

> **get** **contact**(): [`ContactAttachment`](ContactAttachment.md)

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

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:2046

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:2028

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:2048

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:2050

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:2052

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:2054

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:2021

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:2056

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:2019

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:2015

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:2061

##### Returns

[`PaidMediaInfo`](PaidMediaInfo.md)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoAttachment`](PhotoAttachment.md)

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

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:2058

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:2032

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:2034

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

***

### venue

#### Get Signature

> **get** **venue**(): [`Venue`](Venue.md)

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

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:2036

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:2038

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:2040

Message is a voice message, information about the file

##### Returns

[`VoiceAttachment`](VoiceAttachment.md)

## Methods

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

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

`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:743

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:745

#### 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:744 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:751

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:764

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:758

File size, if known

##### Returns

`number`

***

### fileUniqueId

#### Get Signature

> **get** **fileUniqueId**(): `string`

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

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:331

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:335

#### 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:334 |
|  `payload` | `protected` | `T` | - | - | contexts/index.d.ts:332 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:337

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:342

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:634

**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:635 |
| `options.isSelective` | `boolean` | keyboards/index.d.ts:636 |
| `options.placeholder` | `string` | keyboards/index.d.ts:637 |

## Methods

### build()

> **build**(): [`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md)

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

Return [TelegramForceReply](../../../../gramio/interfaces/TelegramForceReply.md) as JSON

#### Returns

[`TelegramForceReply`](../../../../gramio/interfaces/TelegramForceReply.md)

***

### placeholder()

> **placeholder**(`value?`): `this`

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

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:647

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:664

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:5293

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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | [`NodeMixin`](NodeMixin.md).[`isTopicMessage`](NodeMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4990

##### Returns

`string`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`businessConnectionId`](NodeMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`chatId`](NodeMixin.md#chatid)

***

### id

#### Get Signature

> **get** **id**(): `number`

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

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`id`](NodeMixin.md#id)

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`senderId`](NodeMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

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

##### Returns

`number`

#### Inherited from

[`NodeMixin`](NodeMixin.md).[`threadId`](NodeMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

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

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:5307

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:5305

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:5204

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:5206

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:5299

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:5175

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5208

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:5210

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:5068

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:5297

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:5295

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5311

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:5309

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5321

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:5317

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:5315

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:2065

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:2067

#### 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:2066 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:5807

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:5810

#### 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:5807

#### 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:4856 |
|  `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:5809 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:3130

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5295

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:2073

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:2075

#### 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:2074 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2081

Color of the topic icon in RGB format

##### Returns

`number`

***

### iconCustomEmojiId

#### Get Signature

> **get** **iconCustomEmojiId**(): `string`

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

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:2085

*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:2079

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:5822

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:5826

#### 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:5822

#### 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:4856 |
|  `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:5824 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:5830

Color of the topic icon in RGB format

##### Returns

`number`

***

### iconCustomEmojiId

#### Get Signature

> **get** **iconCustomEmojiId**(): `string`

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

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:5828

Name of the topic

##### Returns

`string`

***

### newChatMembers

#### Get Signature

> **get** **newChatMembers**(): [`User`](User.md)\[]

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

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:5834

Checks whether the event has `iconCustomEmojiId` property

#### Returns

`this is Require<ForumTopicCreatedContext<Bot>, "iconCustomEmojiId">`

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

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

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5295

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:2089

This object represents a service message about an edited forum topic.

## Constructors

### Constructor

> **new ForumTopicEdited**(`payload`): `ForumTopicEdited`

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

#### 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:2090 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2097

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:2095

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:5846

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:5850

#### 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:5846

#### 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:4856 |
|  `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:5848 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:5856

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:5852

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:5858

Checks whether the `iconCustomEmojiId` property has been edited

#### Returns

`this is Require<ForumTopicEditedContext<Bot>, "iconCustomEmojiId">`

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

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

`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:5854

Checks whether the `name` property has been edited

#### Returns

`this is Require<ForumTopicEditedContext<Bot>, "name">`

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

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

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5295

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:2101

This object represents a service message about an edited forum topic.

## Constructors

### Constructor

> **new ForumTopicReopened**(`payload`): `ForumTopicReopened`

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

#### 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:2102 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:5870

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:5873

#### 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:5870

#### 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:4856 |
|  `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:5872 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:3130

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5875

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:1721

This object represents a game.

## Constructors

### Constructor

> **new Game**(`payload`): `Game`

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

#### 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:1722 |

## 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`

***

### animation

#### Get Signature

> **get** **animation**(): [`AnimationAttachment`](AnimationAttachment.md)

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

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:1729

Description of the game

##### Returns

`string`

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

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

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:1738

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:1743

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:1727

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:2109

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:2111

#### 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:2110 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:5887

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:5890

#### 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:5887

#### 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:4856 |
|  `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:5889 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:3130

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5892

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:2117

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:2119

#### 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:2118 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:5904

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:5907

#### 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:5904

#### 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:4856 |
|  `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:5906 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:3130

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5909

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:2152

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:2154

#### 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:2153 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2176

*Optional*. Background of the gift

##### Returns

[`GiftBackground`](GiftBackground.md)

***

### hasColors

#### Get Signature

> **get** **hasColors**(): `true`

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

*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:2180

Information about the gift

##### Returns

`string`

***

### isPremium

#### Get Signature

> **get** **isPremium**(): `true`

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

*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:2174

*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:2172

*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:2182

*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:2166

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:2160

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:2158

The sticker that represents the gift

##### Returns

[`StickerAttachment`](StickerAttachment.md)

***

### totalCount

#### Get Signature

> **get** **totalCount**(): `number`

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

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:2178

*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:2162

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:2129

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:2131

#### 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:2130 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### centerColor

#### Get Signature

> **get** **centerColor**(): `number`

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

Center color of the background in RGB format

##### Returns

`number`

***

### edgeColor

#### Get Signature

> **get** **edgeColor**(): `number`

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

Edge color of the background in RGB format

##### Returns

`number`

***

### textColor

#### Get Signature

> **get** **textColor**(): `number`

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

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:5921

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:5925

#### 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:5921

#### 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:4856 |
|  `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:5923 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:5935

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:5931

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:5939

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:5927

Information about the gift

##### Returns

[`Gift`](Gift.md)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

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

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:5941

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:5929

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### prepaidUpgradeStarCount

#### Get Signature

> **get** **prepaidUpgradeStarCount**(): `number`

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

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:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:5937

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:2190

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:2192

#### 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:2191 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2204

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:2200

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:2208

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:2196

Information about the gift

##### Returns

[`Gift`](Gift.md)

***

### isPrivate

#### Get Signature

> **get** **isPrivate**(): `true`

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

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:2212

*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:2198

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:2202

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:2206

Text of the message that was added to the gift

##### Returns

`string`

***

### uniqueGiftNumber

#### Get Signature

> **get** **uniqueGiftNumber**(): `number`

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

*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:5953

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:5957

#### 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:5953

#### 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:4856 |
|  `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:5955 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:5967

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:5963

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:5971

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:5959

Information about the gift

##### Returns

[`Gift`](Gift.md)

***

### giftUpgradeSent

#### Get Signature

> **get** **giftUpgradeSent**(): [`GiftInfo`](GiftInfo.md)

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

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:5973

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:5975

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:5961

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### prepaidUpgradeStarCount

#### Get Signature

> **get** **prepaidUpgradeStarCount**(): `number`

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

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:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:5969

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:3015

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:3234

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:5977

*Optional*. Unique number reserved for this gift when upgraded

##### Returns

`number`

***

### updatedAt

#### Get Signature

> **get** **updatedAt**(): `number`

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

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:1752

This object represents a message about a scheduled giveaway.

## Constructors

### Constructor

> **new Giveaway**(`payload`): `Giveaway`

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

#### 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:1753 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1758

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:1770

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:1764

`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:1772

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:1768

Description of additional giveaway prize

##### Returns

`string`

***

### prizeStarCount

#### Get Signature

> **get** **prizeStarCount**(): `number`

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

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:1762

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:1760

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:1766

`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:2218

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:2220

#### 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:2219 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2230

*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:2228

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:2226

Number of undistributed prizes

##### Returns

`number`

***

### winnerCount

#### Get Signature

> **get** **winnerCount**(): `number`

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

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:5989

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:5992

#### 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:5989

#### 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:4856 |
|  `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:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:5994

Giveaway completed

##### Returns

[`GiveawayCompleted`](GiveawayCompleted.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

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

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:3130

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5295

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:2234

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:2236

#### 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:2235 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2240

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:6006

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:6009

#### 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:6006

#### 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:4856 |
|  `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:6008 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6010

##### Returns

[`GiveawayCreated`](GiveawayCreated.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

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

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:3130

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5295

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:1778

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:1780

#### 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:1779 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1794

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:1784

The chat that created the giveaway

##### Returns

[`Chat`](Chat.md)

***

### messageId

#### Get Signature

> **get** **messageId**(): `number`

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

Identifier of the message with the giveaway in the chat

##### Returns

`number`

***

### onlyNewMembers

#### Get Signature

> **get** **onlyNewMembers**(): `true`

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

`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:1796

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:1804

Description of additional giveaway prize

##### Returns

`string`

***

### prizeStarCount

#### Get Signature

> **get** **prizeStarCount**(): `number`

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

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:1798

Number of undistributed prizes

##### Returns

`number`

***

### winnerCount

#### Get Signature

> **get** **winnerCount**(): `number`

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

Total number of winners in the giveaway

##### Returns

`number`

***

### winners

#### Get Signature

> **get** **winners**(): [`User`](User.md)\[]

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

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:1788

Point in time (Unix timestamp) when winners of the giveaway were selected

##### Returns

`number`

## Methods

### wasRefunded()

> **wasRefunded**(): `true`

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

`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:6022

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:6025

#### 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:6022

#### 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:4856 |
|  `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:6024 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6027

Giveaway winners

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

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

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5307

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:5305

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:5204

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:5206

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:5396

#### 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:5250

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:5299

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:5175

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:5240

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:5177

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:5313

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:5193

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:5194

#### 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:5303

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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5301

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### getTopicIcons()

> **getTopicIcons**(): `Promise`<[`TelegramSticker`](../../../../gramio/interfaces/TelegramSticker.md)\[]>

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

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:4872

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:3130

`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:3063

`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:4876

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:5319

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:5295

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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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:5311

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:5309

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5321

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:5333

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:5317

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:5315

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:5331

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:6039

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:6042

#### 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:6039

#### 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:4856 |
|  `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:6041 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<GroupChatCreatedContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:1467

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:1469

#### 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:1468 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1475

Chat the message belonged to

##### Returns

[`Chat`](Chat.md)

***

### date

#### Get Signature

> **get** **date**(): `number`

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

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:1473

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:416

**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:588

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:582

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:564

#### 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:557

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:469

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:483

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:501

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:525

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:541

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:428

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:592

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:440

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:452

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:565

#### 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:563

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:473

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:489

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:507

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:529

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:547

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:432

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:444

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:456

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:2282

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:2284

#### 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:2283 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2300

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:2330

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:2295

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:2336

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:2313

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:2322

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:2288

Label text on the button

##### Returns

`string`

***

### url

#### Get Signature

> **get** **url**(): `string`

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

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:2340

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:2342

#### 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:2341 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2346

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:4111

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:4113

#### 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:4112 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4119

Sender

##### Returns

[`User`](User.md)

***

### id

#### Get Signature

> **get** **id**(): `string`

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

Unique identifier for this query

##### Returns

`string`

***

### location

#### Get Signature

> **get** **location**(): [`Location`](Location.md)

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

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:4125

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:4123

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:6058

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:6061

#### 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:6058

#### 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:4856 |
|  `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:6060 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4119

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:4117

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:4121

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:4125

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:4123

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:6063

Sender's ID

##### Returns

`number`

## Methods

### answer()

> **answer**(`results`, `params?`): `Promise`<`true`>

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

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:6067

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:5407

#### 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:6065

Checks if query has `location` property

#### Returns

`this is Require<InlineQueryContext<Bot>, "location">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:790

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:792 |

## Methods

### article()

> `static` **article**(`id`, `title`, `inputMessageContent`, `options?`): [`TelegramInlineQueryResultArticle`](../../../../gramio/interfaces/TelegramInlineQueryResultArticle.md)

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

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:804

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:810

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:822

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:828

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:816

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:834

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:840

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:846

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:852

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:858

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:866

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:874

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:880

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:4133

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:4135

#### 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:4134 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4169

*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:4161

*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:4145

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:4181

*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:4149

Location latitude in degrees

##### Returns

`number`

***

### livePeriod

#### Get Signature

> **get** **livePeriod**(): `number`

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

*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:4153

Location longitude in degrees

##### Returns

`number`

***

### proximityAlertRadius

#### Get Signature

> **get** **proximityAlertRadius**(): `number`

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

*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:4177

*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:4193

*Optional*. Thumbnail height

##### Returns

`number`

***

### thumbnailUrl

#### Get Signature

> **get** **thumbnailUrl**(): `string`

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

*Optional*. Url of the thumbnail for the result

##### Returns

`string`

***

### thumbnailWidth

#### Get Signature

> **get** **thumbnailWidth**(): `number`

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

*Optional*. Thumbnail width

##### Returns

`number`

***

### title

#### Get Signature

> **get** **title**(): `string`

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

Location title

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"location"`

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

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:4230

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:4232

#### 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:4231 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### othersCanAddTasks

#### Get Signature

> **get** **othersCanAddTasks**(): `boolean`

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

*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:4259

*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:4243

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:4251

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:4237

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:4247

*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:4201

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:4203

#### 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:4202 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

##### Returns

`string`

***

### id

#### Get Signature

> **get** **id**(): `number`

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

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:4218

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:4212

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:4222

*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:4267

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:4269

#### 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:4268 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4291

*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:4283

*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:4275

Latitude of the location in degrees

##### Returns

`number`

***

### livePeriod

#### Get Signature

> **get** **livePeriod**(): `number`

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

*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:4279

Longitude of the location in degrees

##### Returns

`number`

***

### proximityAlertRadius

#### Get Signature

> **get** **proximityAlertRadius**(): `number`

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

*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:686

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:710

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:716

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:698

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:692

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` | { `toString`: `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:704

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:4303

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:4305

#### 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:4304 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4311

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:4321

*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:4317

*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:1810

This object contains basic information about an invoice.

## Constructors

### Constructor

> **new Invoice**(`payload`): `Invoice`

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

#### 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:1811 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1825

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:1818

Product description

##### Returns

`string`

***

### startParameter

#### Get Signature

> **get** **startParameter**(): `string`

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

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:1816

Product name

##### Returns

`string`

***

### totalAmount

#### Get Signature

> **get** **totalAmount**(): `number`

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

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:6085

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:6088

#### 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:6085

#### 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:4856 |
|  `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:6087 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6090

Invoice

##### Returns

[`Invoice`](Invoice.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

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

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:363

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:357

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:305

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:314

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:323

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:252

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:264

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");
```

***

### requestManagedBot()

> **requestManagedBot**(`text`, `requestId`, `options?`, `buttonOptions?`): `this`

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

If specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot. Available for bots that enabled management of other bots in the [@BotFather](https://t.me/BotFather) Mini App. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `requestId` | `number` |
| `options?` | `Omit`<[`TelegramKeyboardButtonRequestManagedBot`](../../../../gramio/interfaces/TelegramKeyboardButtonRequestManagedBot.md), `"request_id"`> |
| `buttonOptions?` | [`ButtonOptions`](../interfaces/ButtonOptions.md) |

#### Returns

`this`

#### Example

```ts
new Keyboard().requestManagedBot("some button text", 123, {
    suggested_name: "My Bot",
    suggested_username: "my_bot",
});
```

***

### requestPoll()

> **requestPoll**(`text`, `type?`, `options?`): `this`

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

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:334

!**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:345

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:367

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:292

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:256

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:268

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)

***

### requestManagedBot()

> `static` **requestManagedBot**(`text`, `requestId`, `options?`, `buttonOptions?`): [`TelegramKeyboardButton`](../../../../gramio/interfaces/TelegramKeyboardButton.md)

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

If specified, pressing the button will ask the user to create and share a bot that will be managed by the current bot. Available for bots that enabled management of other bots in the [@BotFather](https://t.me/BotFather) Mini App. Available in private chats only.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `text` | `string` |
| `requestId` | `number` |
| `options?` | `Omit`<[`TelegramKeyboardButtonRequestManagedBot`](../../../../gramio/interfaces/TelegramKeyboardButtonRequestManagedBot.md), `"request_id"`> |
| `buttonOptions?` | [`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:284

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:296

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:6102

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:6105

#### 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:6102

#### 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:4856 |
|  `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:6104 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6107

Left chat member

##### Returns

[`User`](User.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

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

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<LeftChatMemberContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:1838

Describes the options used for link preview generation.

## Constructors

### Constructor

> **new LinkPreviewOptions**(`payload`): `LinkPreviewOptions`

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

#### 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:1839 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:1846

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:1844

`true`, if the link preview is disabled

#### Returns

`boolean`

***

### preferLargeMedia()

> **preferLargeMedia**(): `boolean`

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

`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:1848

`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:1852

`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:431

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:433

#### 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:432 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:452

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:441

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:439

Latitude as defined by sender

##### Returns

`number`

***

### livePeriod

#### Get Signature

> **get** **livePeriod**(): `number`

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

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:437

Longitude as defined by sender

##### Returns

`number`

***

### proximityAlertRadius

#### Get Signature

> **get** **proximityAlertRadius**(): `number`

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

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:461

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:433

#### 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:462 |
|  `payload` | [`TelegramLocation`](../../../../gramio/interfaces/TelegramLocation.md) | [`Location`](Location.md).[`payload`](Location.md#payload) | contexts/index.d.ts:432 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:452

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:441

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:439

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:447

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:437

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:457

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:6123

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:6126

#### 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:6123

#### 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:4856 |
|  `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:6125 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6128

Location

##### Returns

[`Location`](Location.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

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

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<LocationContext\<Bot>, "from" | "senderId">

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

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

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

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:2247

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:2249

#### 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:2248 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:2273

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:2265

New text of the button in forwarded messages.

##### Returns

`string`

***

### requestWriteAccess

#### Get Signature

> **get** **requestWriteAccess**(): `boolean`

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

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:2263

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/ManagedBotContext.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ManagedBotContext

# Class: ManagedBotContext\<Bot>

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

This object represents a new bot created to be managed by the current bot, or a bot whose token was changed.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ManagedBotContext`<`Bot`>>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ManagedBotContext`<`Bot`>, `ManagedBotContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ManagedBotContext**<`Bot`>(`options`): `ManagedBotContext`<`Bot`>

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ManagedBotContextOptions`<`Bot`> |

#### Returns

`ManagedBotContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ManagedBotContext**(...`args`): `ManagedBotContext`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ManagedBotContext`

#### 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:4856 |
|  `payload` | `public` | [`TelegramManagedBotUpdated`](../../../../gramio/interfaces/TelegramManagedBotUpdated.md) | The raw data that is used for this Context | [`CloneMixin`](CloneMixin.md).[`payload`](CloneMixin.md#payload) | contexts/index.d.ts:6142 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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)

***

### managedBot

#### Get Signature

> **get** **managedBot**(): [`User`](User.md)

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

Information about the bot. Token of the bot can be fetched using the method `getManagedBotToken`.

##### Returns

[`User`](User.md)

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

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

User that created the bot

##### Returns

[`User`](User.md)

## Methods

### clone()

> **clone**(`options?`): `ManagedBotContext`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ManagedBotContextOptions` |

#### Returns

`ManagedBotContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of the managed bot created by this user

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

#### Inherited from

[`Context`](Context.md).[`is`](Context.md#is)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of the managed bot created by this user and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

---

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

# Class: ManagedBotCreated

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

This object contains information about the bot that was created to be managed by the current bot.

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

## Constructors

### Constructor

> **new ManagedBotCreated**(`payload`): `ManagedBotCreated`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramManagedBotCreated`](../../../../gramio/interfaces/TelegramManagedBotCreated.md) |

#### Returns

`ManagedBotCreated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramManagedBotCreated`](../../../../gramio/interfaces/TelegramManagedBotCreated.md) | contexts/index.d.ts:2355 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### bot

#### Get Signature

> **get** **bot**(): [`User`](User.md)

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

Information about the bot. The bot's token can be fetched using the method `getManagedBotToken`.

##### Returns

[`User`](User.md)

---

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

# Class: ManagedBotCreatedContext\<Bot>

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

This object represents a service message about a user creating a bot that will be managed by the current bot.

## Extends

* [`Context`](Context.md)<`Bot`>.[`Constructor`](../type-aliases/Constructor.md)<`ManagedBotCreatedContext`<`Bot`>>.[`Message`](Message.md).[`TargetMixin`](TargetMixin.md).[`SendMixin`](SendMixin.md)<`Bot`>.[`ChatActionMixin`](ChatActionMixin.md)<`Bot`>.[`NodeMixin`](NodeMixin.md)<`Bot`>.[`ChatMemberControlMixin`](ChatMemberControlMixin.md)<`Bot`>.[`PinsMixin`](PinsMixin.md)<`Bot`>.[`CloneMixin`](CloneMixin.md)<`Bot`, `ManagedBotCreatedContext`<`Bot`>, `ManagedBotCreatedContextOptions`<`Bot`>>

## Type Parameters

| Type Parameter |
| ------ |
| `Bot` *extends* [`BotLike`](../interfaces/BotLike.md) |

## Constructors

### Constructor

> **new ManagedBotCreatedContext**<`Bot`>(`options`): `ManagedBotCreatedContext`<`Bot`>

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options` | `ManagedBotCreatedContextOptions`<`Bot`> |

#### Returns

`ManagedBotCreatedContext`<`Bot`>

#### Overrides

[`Context`](Context.md).[`constructor`](Context.md#constructor)

***

### Constructor

> **new ManagedBotCreatedContext**(...`args`): `ManagedBotCreatedContext`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| ...`args` | `any`\[] |

#### Returns

`ManagedBotCreatedContext`

#### 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:4856 |
|  `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:6167 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBot

#### Get Signature

> **get** **managedBot**(): [`User`](User.md)

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

Information about the bot. The bot's token can be fetched using the method `getManagedBotToken`.

##### Returns

[`User`](User.md)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

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

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

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

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

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

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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

### banMember()

> **banMember**(`params?`): `Promise`<`true`>

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

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:5218

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?`): `ManagedBotCreatedContext`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `options?` | `ManagedBotCreatedContextOptions` |

#### Returns

`ManagedBotCreatedContext`

#### Inherited from

[`CloneMixin`](CloneMixin.md).[`clone`](CloneMixin.md#clone)

***

### copy()

> **copy**(`params?`): `Promise`<[`MessageId`](MessageId.md)>

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

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

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

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<ManagedBotCreatedContext\<Bot>, "from" | "senderId">

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

Checks if the instance has `from` and `senderId` properties

#### Returns

this is Require\<ManagedBotCreatedContext\<Bot>, "from" | "senderId">

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasFrom`](TargetMixin.md#hasfrom)

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

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

`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:3063

`true`, if the message can't be forwarded

#### Returns

`true`

#### Inherited from

[`Message`](Message.md).[`hasProtectedContent`](Message.md#hasprotectedcontent)

***

### hasSenderChat()

> **hasSenderChat**(): `this is Require<ManagedBotCreatedContext<Bot>, "senderChat">`

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

Checks if the instance has `senderChat` property

#### Returns

`this is Require<ManagedBotCreatedContext<Bot>, "senderChat">`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`hasSenderChat`](TargetMixin.md#hassenderchat)

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

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

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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<ManagedBotCreatedContext<Bot>, "chatType", Channel>`

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

Is this chat a channel?

#### Returns

`this is RequireValue<ManagedBotCreatedContext<Bot>, "chatType", Channel>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isChannel`](TargetMixin.md#ischannel)

***

### isFromOffline()

> **isFromOffline**(): `true`

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

`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<ManagedBotCreatedContext<Bot>, "chatType", Group>`

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

Is this chat a group?

#### Returns

`this is RequireValue<ManagedBotCreatedContext<Bot>, "chatType", Group>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isGroup`](TargetMixin.md#isgroup)

***

### isPaidPost()

> **isPaidPost**(): `true`

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

*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<ManagedBotCreatedContext<Bot>, "chatType", Private>`

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

Is this chat a private one?

#### Returns

`this is RequireValue<ManagedBotCreatedContext<Bot>, "chatType", Private>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isPM`](TargetMixin.md#ispm)

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

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

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<ManagedBotCreatedContext<Bot>, "chatType", Supergroup>`

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

Is this chat a supergroup?

#### Returns

`this is RequireValue<ManagedBotCreatedContext<Bot>, "chatType", Supergroup>`

#### Inherited from

[`TargetMixin`](TargetMixin.md).[`isSupergroup`](TargetMixin.md#issupergroup)

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

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

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

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

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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)

***

### send()

> **send**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

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

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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)

***

### setMemberTag()

> **setMemberTag**(`tag`, `params?`): `Promise`<`true`>

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

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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)

***

### unbanMember()

> **unbanMember**(`params?`): `Promise`<`true`>

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

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:5333

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:5331

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/ManagedBotUpdated.md'
---
[GramIO API Reference](../../../../index.md) / [@gramio/contexts/dist](../index.md) / ManagedBotUpdated

# Class: ManagedBotUpdated

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

This object contains information about the creation or token update of a bot that is managed by the current bot.

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

## Constructors

### Constructor

> **new ManagedBotUpdated**(`payload`): `ManagedBotUpdated`

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | [`TelegramManagedBotUpdated`](../../../../gramio/interfaces/TelegramManagedBotUpdated.md) |

#### Returns

`ManagedBotUpdated`

## Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
|  `payload` | [`TelegramManagedBotUpdated`](../../../../gramio/interfaces/TelegramManagedBotUpdated.md) | contexts/index.d.ts:4330 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag)

##### Returns

`string`

***

### bot

#### Get Signature

> **get** **bot**(): [`User`](User.md)

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

Information about the bot. Token of the bot can be fetched using the method `getManagedBotToken`.

##### Returns

[`User`](User.md)

***

### user

#### Get Signature

> **get** **user**(): [`User`](User.md)

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

User that created the bot

##### Returns

[`User`](User.md)

---

---
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:771

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:773

#### 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:772 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:780

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:794

Mask scaling coefficient. For example, `2.0` means double size.

##### Returns

`number`

***

### xShift

#### Get Signature

> **get** **xShift**(): `number`

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

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:792

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:4353

This object describes the bot's menu button in a private chat.

## Constructors

### Constructor

> **new MenuButton**(`payload`): `MenuButton`

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

#### 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:4354 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:4361

Text on the button

##### Returns

`any`

***

### type

#### Get Signature

> **get** **type**(): `"default"` | `"commands"` | `"web_app"`

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

Type of the button

##### Returns

`"default"` | `"commands"` | `"web_app"`

***

### webApp

#### Get Signature

> **get** **webApp**(): [`WebAppInfo`](WebAppInfo.md)

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

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:3007

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)
* [`ManagedBotCreatedContext`](ManagedBotCreatedContext.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)
* [`PollOptionAddedContext`](PollOptionAddedContext.md)
* [`PollOptionDeletedContext`](PollOptionDeletedContext.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:3009

#### 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:3008 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

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

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

Conversation the message belongs to

##### Returns

[`Chat`](Chat.md)

***

### chatBackgroundSet

#### Get Signature

> **get** **chatBackgroundSet**(): [`ChatBackground`](ChatBackground.md)

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

Service message: chat background set

##### Returns

[`ChatBackground`](ChatBackground.md)

***

### chatBoostAdded

#### Get Signature

> **get** **chatBoostAdded**(): [`ChatBoostAdded`](ChatBoostAdded.md)

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

Service message: chat boost added

##### Returns

[`ChatBoostAdded`](ChatBoostAdded.md)

***

### chatOwnerChanged

#### Get Signature

> **get** **chatOwnerChanged**(): [`ChatOwnerChanged`](ChatOwnerChanged.md)

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

Service message: chat owner has changed

##### Returns

[`ChatOwnerChanged`](ChatOwnerChanged.md)

***

### chatOwnerLeft

#### Get Signature

> **get** **chatOwnerLeft**(): [`ChatOwnerLeft`](ChatOwnerLeft.md)

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

Service message: chat owner has left

##### Returns

[`ChatOwnerLeft`](ChatOwnerLeft.md)

***

### chatShared

#### Get Signature

> **get** **chatShared**(): [`ChatShared`](ChatShared.md)

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

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:3053

##### Returns

[`Checklist`](Checklist.md)

***

### checklistTasksAdded

#### Get Signature

> **get** **checklistTasksAdded**(): [`ChecklistTasksAdded`](ChecklistTasksAdded.md)

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

Service message: checklist tasks added

##### Returns

[`ChecklistTasksAdded`](ChecklistTasksAdded.md)

***

### checklistTasksDone

#### Get Signature

> **get** **checklistTasksDone**(): [`ChecklistTasksDone`](ChecklistTasksDone.md)

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

Service message: checklist tasks done

##### Returns

[`ChecklistTasksDone`](ChecklistTasksDone.md)

***

### connectedWebsite

#### Get Signature

> **get** **connectedWebsite**(): `string`

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

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:3132

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:3034

Date the message was sent in Unix time

##### Returns

`number`

***

### deleteChatPhoto

#### Get Signature

> **get** **deleteChatPhoto**(): `true`

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

Service message: the chat photo was deleted

##### Returns

`true`

***

### dice

#### Get Signature

> **get** **dice**(): [`Dice`](Dice.md)

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

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:3253

Service message: direct message price changed

##### Returns

[`DirectMessagePriceChanged`](DirectMessagePriceChanged.md)

***

### directMessagesTopic

#### Get Signature

> **get** **directMessagesTopic**(): [`DirectMessagesTopic`](DirectMessagesTopic.md)

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

*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:3102

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:3093

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:3087

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:3055

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:3269

Service message: forum topic closed

##### Returns

[`ForumTopicClosed`](ForumTopicClosed.md)

***

### forumTopicCreated

#### Get Signature

> **get** **forumTopicCreated**(): [`ForumTopicCreated`](ForumTopicCreated.md)

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

Service message: forum topic created

##### Returns

[`ForumTopicCreated`](ForumTopicCreated.md)

***

### forumTopicEdited

#### Get Signature

> **get** **forumTopicEdited**(): [`ForumTopicEdited`](ForumTopicEdited.md)

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

Service message: forum topic edited

##### Returns

[`ForumTopicEdited`](ForumTopicEdited.md)

***

### forumTopicReopened

#### Get Signature

> **get** **forumTopicReopened**(): [`ForumTopicReopened`](ForumTopicReopened.md)

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

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

A giveaway with public winners was completed

##### Returns

[`GiveawayWinners`](GiveawayWinners.md)

***

### groupChatCreated

#### Get Signature

> **get** **groupChatCreated**(): `true`

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

Service message: the group has been created

##### Returns

`true`

***

### id

#### Get Signature

> **get** **id**(): `number`

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

Unique message identifier inside this chat

##### Returns

`number`

***

### invoice

#### Get Signature

> **get** **invoice**(): [`Invoice`](Invoice.md)

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

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

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

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

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

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:3188

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:3211

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:3203

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:3161

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:3174

A chat photo was change to this value

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### newChatTitle

#### Get Signature

> **get** **newChatTitle**(): `string`

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

A chat title was changed to this value

##### Returns

`string`

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

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

*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:3156

Telegram Passport data

##### Returns

[`PassportData`](PassportData.md)

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoSize`](PhotoSize.md)\[]

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

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

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

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

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

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

For replies, the original message

##### Returns

`Omit`<`Message`, `"replyMessage"`>

***

### replyStory

#### Get Signature

> **get** **replyStory**(): [`Story`](Story.md)

Defined in: contexts/index.d.ts:3048

For replies to a story, the original story

##### Returns

[`Story`](Story.md)

***

### replyToChecklistTaskId

#### Get Signature

> **get** **replyToChecklistTaskId**(): `number`

Defined in: contexts/index.d.ts:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:3032

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:3106

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:3108

Message is a forwarded story

##### Returns

[`StoryAttachment`](StoryAttachment.md)

***

### successfulPayment

#### Get Signature

> **get** **successfulPayment**(): [`SuccessfulPayment`](SuccessfulPayment.md)

Defined in: contexts/index.d.ts:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

Service message: video chat ended

##### Returns

[`VideoChatEnded`](VideoChatEnded.md)

***

### videoChatParticipantsInvited

#### Get Signature

> **get** **videoChatParticipantsInvited**(): [`VideoChatParticipantsInvited`](VideoChatParticipantsInvited.md)

Defined in: contexts/index.d.ts:3291

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:3285

Service message: video chat scheduled

##### Returns

[`VideoChatScheduled`](VideoChatScheduled.md)

***

### videoChatStarted

#### Get Signature

> **get** **videoChatStarted**(): [`VideoChatStarted`](VideoChatStarted.md)

Defined in: contexts/index.d.ts:3287

Service message: video chat started

##### Returns

[`VideoChatStarted`](VideoChatStarted.md)

***

### videoNote

#### Get Signature

> **get** **videoNote**(): [`VideoNoteAttachment`](VideoNoteAttachment.md)

Defined in: contexts/index.d.ts:3112

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:3114

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:3293

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:3242

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:3130

`true`, if the message media is covered by a spoiler animation

#### Returns

`true`

***

### hasProtectedContent()

> **hasProtectedContent**(): `true`

Defined in: contexts/index.d.ts:3063

`true`, if the message can't be forwarded

#### Returns

`true`

***

### isAutomaticForward()

> **isAutomaticForward**(): `true`

Defined in: contexts/index.d.ts:3044

`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:3065

`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:3067

*Optional*. *True*, if the message is a paid post

#### Returns

`true`

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3128

True, if the caption must be shown above the message media

#### Returns

`boolean`

***

### isTopicMessage()

> **isTopicMessage**(): `boolean`

Defined in: contexts/index.d.ts:3042

`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:2366

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:2368

#### 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:2367 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2370

[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:2372

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:6189

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:6192

#### 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:6189

#### 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:4856 |
|  `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:6191 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:3100

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:3074

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:6194

Message auto delete timer

##### Returns

[`MessageAutoDeleteTimerChanged`](MessageAutoDeleteTimerChanged.md)

***

### businessConnectionId

#### Get Signature

> **get** **businessConnectionId**(): `string`

Defined in: contexts/index.d.ts:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:4916

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:4920

#### 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:4916

#### 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:4856 |
|  `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:4919 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:4955

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:3100

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:3074

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:3036

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:4932

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:4933

##### 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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:4965

Event type

##### Returns

[`MessageEventName`](../type-aliases/MessageEventName.md)

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:4953

##### Returns

[`PaidMediaInfo`](PaidMediaInfo.md)

***

### paidStarCount

#### Get Signature

> **get** **paidStarCount**(): `number`

Defined in: contexts/index.d.ts:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:4939

Value after the `/start` command

##### Returns

`string`

***

### replyMarkup

#### Get Signature

> **get** **replyMarkup**(): [`InlineKeyboardMarkup`](InlineKeyboardMarkup.md)

Defined in: contexts/index.d.ts:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:4944

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:4924

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:4925

##### 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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5418

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:5419

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5272

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasAttachment()

> **hasAttachment**(): `this is Require<MessageContext<Bot>, "attachment">`

Defined in: contexts/index.d.ts:4959

Does this message even have an attachment?

#### Returns

`this is Require<MessageContext<Bot>, "attachment">`

***

### ~~hasAttachments()~~

> **hasAttachments**(`type?`): `boolean`

Defined in: contexts/index.d.ts:4983

#### 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:4957

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:4948

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:4935

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:4952

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:4937

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:4950

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:4971

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:4872

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:4975

Does this message have link preview options?

#### Returns

`this is Require<MessageContext<Bot>, "linkPreviewOptions">`

***

### hasMediaSpoiler()

> **hasMediaSpoiler**(): `true`

Defined in: contexts/index.d.ts:3130

`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:3063

`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:4973

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:4977

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:4979

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:4876

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:4946

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:4927

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:4981

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:4963

Is this message an event?

#### Returns

`boolean`

***

### isFromOffline()

> **isFromOffline**(): `true`

Defined in: contexts/index.d.ts:3065

`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:4961

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:4901

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:3067

*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:4899

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:4967

Is this message a service one?

#### Returns

`boolean`

***

### isShowCaptionAboveMedia()

> **isShowCaptionAboveMedia**(): `boolean`

Defined in: contexts/index.d.ts:3128

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:4903

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:4969

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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5274

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<`MessageContext`<`Bot`>>

Defined in: contexts/index.d.ts:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5230

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:550

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:552

#### 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:551 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:554

[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:585

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:589

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:579

For `pre` only, the programming language of the entity text

##### Returns

`string`

***

### length

#### Get Signature

> **get** **length**(): `number`

Defined in: contexts/index.d.ts:571

Length of the entity in UTF-16 code units

##### Returns

`number`

***

### offset

#### Get Signature

> **get** **offset**(): `number`

Defined in: contexts/index.d.ts:569

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:567

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:587

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:575

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:577

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:4371

This object represents a unique message identifier.

## Constructors

### Constructor

> **new MessageId**(`payload`): `MessageId`

Defined in: contexts/index.d.ts:4373

#### 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:4372 |

## Accessors

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4375

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:1909

The message was originally sent to a channel chat.

## Extends

* `MessageOrigin`

## Constructors

### Constructor

> **new MessageOriginChannel**(`payload`): `MessageOriginChannel`

Defined in: contexts/index.d.ts:1911

#### 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:1910 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1903

[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:1921

Signature of the original post author

##### Returns

`string`

***

### chat

#### Get Signature

> **get** **chat**(): [`Chat`](Chat.md)

Defined in: contexts/index.d.ts:1917

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:1915

Date the message was sent originally in Unix time

##### Returns

`number`

***

### messageId

#### Get Signature

> **get** **messageId**(): `number`

Defined in: contexts/index.d.ts:1919

Unique message identifier inside the chat

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"channel"`

Defined in: contexts/index.d.ts:1913

Type of the message origin, always `channel`

##### Returns

`"channel"`

## Methods

### is()

> **is**<`T`>(`type`): `this is MessageOriginMapping[T]`

Defined in: contexts/index.d.ts:1905

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:1856

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:1858

#### 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:1857 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1903

[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:1866

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:1862

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:1864

Chat that sent the message originally

##### Returns

[`Chat`](Chat.md)

***

### type

#### Get Signature

> **get** **type**(): `"chat"`

Defined in: contexts/index.d.ts:1860

Type of the message origin, always `chat`

##### Returns

`"chat"`

## Methods

### is()

> **is**<`T`>(`type`): `this is MessageOriginMapping[T]`

Defined in: contexts/index.d.ts:1905

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:1870

The message was originally sent by an unknown user.

## Extends

* `MessageOrigin`

## Constructors

### Constructor

> **new MessageOriginHiddenUser**(`payload`): `MessageOriginHiddenUser`

Defined in: contexts/index.d.ts:1872

#### 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:1871 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1903

[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:1876

Date the message was sent originally in Unix time

##### Returns

`number`

***

### senderUserName

#### Get Signature

> **get** **senderUserName**(): `string`

Defined in: contexts/index.d.ts:1878

Name of the user that sent the message originally

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"hidden_user"`

Defined in: contexts/index.d.ts:1874

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:1905

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:1882

The message was originally sent by a known user.

## Extends

* `MessageOrigin`

## Constructors

### Constructor

> **new MessageOriginUser**(`payload`): `MessageOriginUser`

Defined in: contexts/index.d.ts:1884

#### 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:1883 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1903

[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:1888

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:1890

User that sent the message originally

##### Returns

[`User`](User.md)

***

### type

#### Get Signature

> **get** **type**(): `"user"`

Defined in: contexts/index.d.ts:1886

Type of the message origin, always `user`

##### Returns

`"user"`

## Methods

### is()

> **is**<`T`>(`type`): `this is MessageOriginMapping[T]`

Defined in: contexts/index.d.ts:1905

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:6206

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:6209

#### 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:6206

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:6208 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:4461

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:4990

##### 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:4455

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:4989

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:4463

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:4457

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:4467

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:4465

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:4991

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4992

##### 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:4459

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:5218

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:5407

#### 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:5204

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:5206

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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:6213

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:6211

Checks if context has the `user` property

#### Returns

`this is Require<MessageReactionContext<Bot>, "user">`

***

### is()

> **is**<`T`>(`rawTypes`): `this is InstanceType<ContextsMapping<Bot>[T]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:6225

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:6228

#### 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:6225

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:6227 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:4990

##### 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:4439

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:4989

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### date

#### Get Signature

> **get** **date**(): `number`

Defined in: contexts/index.d.ts:4443

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:4441

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:4445

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:4991

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4992

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5218

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:5407

#### 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:5204

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:5206

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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:4433

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:4435

#### 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:4434 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4437

[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:4439

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:4443

Date of the change in Unix time

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4441

Unique identifier of the message inside the chat

##### Returns

`number`

***

### reactions

#### Get Signature

> **get** **reactions**(): `ReactionType`\[]

Defined in: contexts/index.d.ts:4445

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:4449

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:4451

#### 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:4450 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4453

[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:4461

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:4455

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:4463

Date of the change in Unix time

##### Returns

`number`

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:4457

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:4467

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:4465

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:4459

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:6240

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:6243

#### 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:6240

#### 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:4856 |
|  `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:6242 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6245

Chat ID

##### Returns

`number`

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:6257

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:6260

#### 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:6257

#### 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:4856 |
|  `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:6259 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6262

Chat ID

##### Returns

`number`

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5333

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:5331

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:6274

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:6277

#### 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:6274

#### 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:4856 |
|  `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:6276 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6279

New chat members

##### Returns

[`User`](User.md)\[]

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5272

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<NewChatMembersContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5274

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5230

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:6291

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:6294

#### 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:6291

#### 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:4856 |
|  `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:6293 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6296

New chat photo

##### Returns

[`PhotoSize`](PhotoSize.md)\[]

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5272

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<NewChatPhotoContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5274

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5230

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:6308

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:6311

#### 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:6308

#### 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:4856 |
|  `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:6310 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:6313

New chat title

##### Returns

`string`

***

### externalReply

#### Get Signature

> **get** **externalReply**(): [`ExternalReplyInfo`](ExternalReplyInfo.md)

Defined in: contexts/index.d.ts:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5282

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:5262

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5250

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:5175

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:5240

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:5177

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:5193

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:5194

#### 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:5252

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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5248

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:5208

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:5210

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:5068

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)

***

### getManagedBotToken()

> **getManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5272

Returns the token of a managed bot

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`GetManagedBotTokenParams`](../../../../gramio/interfaces/GetManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`getManagedBotToken`](ChatMemberControlMixin.md#getmanagedbottoken)

***

### hasFrom()

> **hasFrom**(): this is Require\<NewChatTitleContext\<Bot>, "from" | "senderId">

Defined in: contexts/index.d.ts:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5268

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5232

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)

***

### replaceManagedBotToken()

> **replaceManagedBotToken**(`params?`): `Promise`<`string`>

Defined in: contexts/index.d.ts:5274

Revokes the current token of a managed bot and generates a new one

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`ReplaceManagedBotTokenParams`](../../../../gramio/interfaces/ReplaceManagedBotTokenParams.md), `"user_id"`> |

#### Returns

`Promise`<`string`>

#### Inherited from

[`ChatMemberControlMixin`](ChatMemberControlMixin.md).[`replaceManagedBotToken`](ChatMemberControlMixin.md#replacemanagedbottoken)

***

### reply()

> **reply**(`text`, `params?`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:5266

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:5254

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5228

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:5236

Changes chat description

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `description` | `string` |
| `params?` | [`Optional`](../type-aliases/Optional.md)<[`SetChatDescriptionParams`](../../../../gramio/interfaces/SetChatDescriptionParams.md), `"description"` | `"chat_id"`> |

#### Returns

`Promise`<`true`>

#### Inherited from

[`ChatControlMixin`](ChatControlMixin.md).[`setChatDescription`](ChatControlMixin.md#setchatdescription)

***

### setChatPhoto()

> **setChatPhoto**(`photo`, `params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5230

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:5238

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:5234

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:5226

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:5270

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:5284

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:5264

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:5333

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:5331

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:5084

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)
* [`ManagedBotCreatedContext`](ManagedBotCreatedContext.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)
* [`PollOptionAddedContext`](PollOptionAddedContext.md)
* [`PollOptionDeletedContext`](PollOptionDeletedContext.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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:4990

##### Returns

`string`

#### Inherited from

[`SendMixin`](SendMixin.md).[`businessConnectionId`](SendMixin.md#businessconnectionid)

***

### chatId

#### Get Signature

> **get** **chatId**(): `number`

Defined in: contexts/index.d.ts:4989

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`chatId`](SendMixin.md#chatid)

***

### id

#### Get Signature

> **get** **id**(): `number`

Defined in: contexts/index.d.ts:5074

##### Returns

`number`

***

### senderId

#### Get Signature

> **get** **senderId**(): `number`

Defined in: contexts/index.d.ts:4991

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`senderId`](SendMixin.md#senderid)

***

### threadId

#### Get Signature

> **get** **threadId**(): `number`

Defined in: contexts/index.d.ts:4992

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clearReactions()

> **clearReactions**(`params?`): `Promise`<`true`>

Defined in: contexts/index.d.ts:5218

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:5204

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:5206

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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `object` & `object` |

#### Returns

`Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

***

### quoteWithSticker()

> **quoteWithSticker**(`params`): `Promise`<[`MessageContext`](MessageContext.md)<`Bot`>>

Defined in: contexts/index.d.ts:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

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:5116

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:5090

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:5106

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:5104

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:5102

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:5088

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:5112

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:5118

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:5114

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:5108

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:5094

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:5098

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:5100

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5212

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:5214

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:5185

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:5183

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:5028

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:5066

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:2593

This object represents information about an order.

## Constructors

### Constructor

> **new OrderInfo**(`payload`): `OrderInfo`

Defined in: contexts/index.d.ts:2595

#### 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:2594 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:2597

[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:2603

User email

##### Returns

`string`

***

### name

#### Get Signature

> **get** **name**(): `string`

Defined in: contexts/index.d.ts:2599

User name

##### Returns

`string`

***

### phoneNumber

#### Get Signature

> **get** **phoneNumber**(): `string`

Defined in: contexts/index.d.ts:2601

User's phone number

##### Returns

`string`

***

### shippingAddress

#### Get Signature

> **get** **shippingAddress**(): [`ShippingAddress`](ShippingAddress.md)

Defined in: contexts/index.d.ts:2605

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:1994

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:1996

#### 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:1995 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1997

##### Returns

`string`

***

### paidMedia

#### Get Signature

> **get** **paidMedia**(): ([`PaidMediaPreview`](PaidMediaPreview.md) | [`PaidMediaVideo`](PaidMediaVideo.md) | [`PaidMediaPhoto`](PaidMediaPhoto.md))\[]

Defined in: contexts/index.d.ts:2005

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:2001

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:1929

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:1931

#### 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:1930 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1932

##### Returns

`string`

***

### photo

#### Get Signature

> **get** **photo**(): [`PhotoAttachment`](PhotoAttachment.md)

Defined in: contexts/index.d.ts:1940

The photo

##### Returns

[`PhotoAttachment`](PhotoAttachment.md)

***

### type

#### Get Signature

> **get** **type**(): `"photo"`

Defined in: contexts/index.d.ts:1936

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:1967

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:1969

#### 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:1968 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1970

##### Returns

`string`

***

### duration

#### Get Signature

> **get** **duration**(): `number`

Defined in: contexts/index.d.ts:1986

*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:1982

*Optional*. Media height as defined by the sender

##### Returns

`number`

***

### type

#### Get Signature

> **get** **type**(): `"preview"`

Defined in: contexts/index.d.ts:1974

Type of the paid media, always “preview”

##### Returns

`"preview"`

***

### width

#### Get Signature

> **get** **width**(): `number`

Defined in: contexts/index.d.ts:1978

*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:6329

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:6332

#### 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:6329

#### 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:4856 |
|  `isTopicMessage` | `public` | () => `boolean` | - | [`SendMixin`](SendMixin.md).[`isTopicMessage`](SendMixin.md#istopicmessage) | contexts/index.d.ts:4993 |
|  `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:6331 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:4895

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:4889

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:4893

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:4897

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:6333

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:6335

Bot-specified paid media payload

##### Returns

`string`

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:4887

*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:4883

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:4891

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:4992

##### Returns

`number`

#### Inherited from

[`SendMixin`](SendMixin.md).[`threadId`](SendMixin.md#threadid)

## Methods

### clone()

> **clone**(`options?`): `PaidMediaPurchasedContext`

Defined in: contexts/index.d.ts:5407

#### 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:5068

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:4872

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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:4905

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:4901

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:4899

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:4903

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:4998

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:5008

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:5004

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:5032

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:5024

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:5020

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:5034

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:5002

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:5016

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:5014

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:5051

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:5038

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:5030

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:5036

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:5000

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:5022

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:5026

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:5018

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:5006

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:5010

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:5012

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:5028

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:5066

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:1948

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:1950

#### 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:1949 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:1951

##### Returns

`string`

***

### type

#### Get Signature

> **get** **type**(): `"video"`

Defined in: contexts/index.d.ts:1955

Type of the paid media, always “video”

##### Returns

`"video"`

***

### video

#### Get Signature

> **get** **video**(): [`VideoAttachment`](VideoAttachment.md)

Defined in: contexts/index.d.ts:1959

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:6351

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:6355

#### 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:6351

#### 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:4856 |
|  `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:6353 |
|  `update?` | `public` | [`TelegramUpdate`](../../../../gramio/interfaces/TelegramUpdate.md) | - | [`Context`](Context.md).[`update`](Context.md#update) | contexts/index.d.ts:4858 |
|  `updateId?` | `public` | `number` | - | [`Context`](Context.md).[`updateId`](Context.md#updateid) | contexts/index.d.ts:4857 |
|  `updateType` | `protected` | [`UpdateName`](../type-aliases/UpdateName.md) | - | [`Context`](Context.md).[`updateType`](Context.md#updatetype) | contexts/index.d.ts:4859 |

## Accessors

### \[toStringTag]

#### Get Signature

> **get** **\[toStringTag]**(): `string`

Defined in: contexts/index.d.ts:4862

[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:3098

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:3100

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:3074

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:3036

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:3119

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:3124

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:3195

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:3038

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:3246

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:3244

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:4893

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:3170

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:3168

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:3228

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:4897

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:3053

##### 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:3251

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:3248

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:3154

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:3132

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:3034

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:3176

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:3134

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:3253

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:3017

*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:3102

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:3093

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:3087

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:3055

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:3269

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:3265

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:3267

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:3271

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:3040

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:3019

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:3136

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:3273

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:3275

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:3230

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:3232

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:3277

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:3281

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:3279

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:3283

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:3178

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:3013

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:3219

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:3166

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:3089

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:3146

Message is a shared location, information about the location

##### Returns

[`Location`](Location.md)

#### Inherited from

[`Message`](Message.md).[`location`](Message.md#location)

***

### managedBotCreated

#### Get Signature

> **get** **managedBotCreated**(): [`ManagedBotCreated`](ManagedBotCreated.md)

Defined in: contexts/index.d.ts:3295

Service message: user created a bot that will be managed by the current bot

##### Returns

[`ManagedBotCreated`](ManagedBotCreated.md)

#### Inherited from

[`Message`](Message.md).[`managedBotCreated`](Message.md#managedbotcreated)

***

### mediaGroupId

#### Get Signature

> **get** **mediaGroupId**(): `string`

Defined in: contexts/index.d.ts:3069

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:3188

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:3211

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:3203

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:3161

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:3174

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:3172

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:6359

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:3078

*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:3156

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:3104

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:3217

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:3138

Message is a native poll, information about the poll

##### Returns

[`Poll`](Poll.md)

#### Inherited from

[`Message`](Message.md).[`poll`](Message.md#poll)

***

### pollOptionAdded

#### Get Signature

> **get** **pollOptionAdded**(): [`PollOptionAdded`](PollOptionAdded.md)

Defined in: contexts/index.d.ts:3297

Service message: answer option was added to a poll

##### Returns

[`PollOptionAdded`](PollOptionAdded.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionAdded`](Message.md#polloptionadded)

***

### pollOptionDeleted

#### Get Signature

> **get** **pollOptionDeleted**(): [`PollOptionDeleted`](PollOptionDeleted.md)

Defined in: contexts/index.d.ts:3299

Service message: answer option was deleted from a poll

##### Returns

[`PollOptionDeleted`](PollOptionDeleted.md)

#### Inherited from

[`Message`](Message.md).[`pollOptionDeleted`](Message.md#polloptiondeleted)

***

### proximityAlertTriggered

#### Get Signature

> **get** **proximityAlertTriggered**(): [`ProximityAlertTriggered`](ProximityAlertTriggered.md)

Defined in: contexts/index.d.ts:3240

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:3057

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:3152

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:3046

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:3048

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:3050

*Optional*. Identifier of the specific checklist task that is being replied to

##### Returns

`number`

#### Inherited from

[`Message`](Message.md).[`replyToChecklistTaskId`](Message.md#replytochecklisttaskid)

***

### replyToPollOptionId

#### Get Signature

> **get** **replyToPollOptionId**(): `string`

Defined in: contexts/index.d.ts:3052

*Optional*. Persistent identifier of the specific poll option that is being replied to

##### Returns

`string`

#### Inherited from

[`Message`](Message.md).[`replyToPollOptionId`](Message.md#replytopolloptionid)

***

### senderBoostCount

#### Get Signature

> **get** **senderBoostCount**(): `number`

Defined in: contexts/index.d.ts:3028

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:3030

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:3026

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:4891

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:3032

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:3106

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:3108

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:3224

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:3257

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:3255

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:3259

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:3091

*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:3261

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:3263

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:3186

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:3082

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:3015

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:3234

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:3061

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:3226

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:3144

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:3059

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:3110

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:3289

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:3291

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:3285

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:3287

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:3112

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:3114

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:3293

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:3242

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:5218

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:5407

#### 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:5204

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:5206

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:5396

#### 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:5175

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:5177

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:5193

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:5194

#### 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:5181

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:5198

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:5191

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:5179

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:5196

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:5200

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:5187

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:5202

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:5189

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:5208

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:5210

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:5068

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:4872

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:3130

`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:3063

`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:4876

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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : Bot["__Derives"] extends {} ? Bot["__Derives"]["global"] & Bot["__Derives"][T] : {})`

Defined in: contexts/index.d.ts:4865

#### 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]> & GetDerives<Bot, T> & (IsAny<Bot["__Derives"]> extends true ? {} : 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:3044

`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:4905

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:3065

`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:4901

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:3067

*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:4899

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:3128

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:4903

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:3042

`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:5329

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:5138

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:5130

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:5163

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:5171

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:5126

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:5159

Replies to current message with a quote and an invoice

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | `object` & `Pick`<[`SendInvoiceParams`](../../../../gramio/interfaces/SendInvoiceParams.md), `"payload"` | `"currency"` | `"description"` | `"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"` | `"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:5154

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:5150

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:5122

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:5165

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"` | `"description"` | `"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"` | `"allows_revoting"` | `"shuffle_options"` | `"allow_adding_options"` | `"hide_results_until_closes"` | `"correct_option_ids"` | `"explanation_parse_mode"` | `"explanation_entities"` | `"open_period"` | `"close_date"` | `"is_closed"` | `"description_parse_mode"` | `"description_entities"`> & `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:5167

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:5161

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:5134

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:5142

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:5146

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:5216

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:5086

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:5096

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:5092

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:5110

Replies to current message with contact

#### Parameters

| Parameter | Type |
| ------ | ------ |
|