Nestgram
  • ⭐About Nestgram
  • 📄Guide
  • 📰News
  • đŸ”ŧHandling updates
    • Handling commands
    • Handling text messages
    • Handling other updates
    • Entities: url, email and other
    • Other arguments in handler
    • Handling media files and download it
  • đŸĒļNestgram Features
    • Services
    • Middlewares and Params
    • Sending messages correctly
    • Answer class
    • Scopes
    • States
    • Views
  • đŸ’ŦMessages
    • Sending a photo, video and other media
    • Sending a media group
    • Send location (live) or venue
    • Send contact
    • Send poll
    • Send dice
    • Edit/delete messages
    • Copy or Forward a message
  • âŒ¨ī¸Keyboards
    • Keyboard types, building keyboard
    • Handle underTheMessage keyboard button click by Alert or Toast
    • Keyboard layouts
  • âš™ī¸Config
    • CLI
    • Webhooks and run config
    • Api class
    • Modules
      • Mongo module
    • Controller Helper class
  • 🤖API Reference
    • Set chat action
    • Save user profile photo
    • Ban, unban user or chat
    • Restrict or Promote user
    • Set chat permissions
    • Set chat admin custom title
    • Chat invite links
    • Join requests
    • Update chat info, photo, title, description and more
    • Pin or unpin messages
    • Get chat info, leave chat
    • Check user subscription
    • Chat sticker set
    • My commands
    • My default admin rights
    • Menu button
Powered by GitBook
On this page
  • Get chat info
  • Get chat admins
  • Get chat member count
  • Get chat member
  • Leave chat
  1. API Reference

Get chat info, leave chat

You can get chat info: chat member count, chat info, chat admins, chat member and other

PreviousPin or unpin messagesNextCheck user subscription

Last updated 2 years ago

Get chat info

To get chat info, use .getChat answer/api method

.getChat answer/api method takes argument: chat id you want to get (optional in answer method, current chat id by default)

If you want to know what arguments an API method takes, see the IDE hint

Returns on success

Get chat admins

To get chat administrators, use .getChatAdmins answer/api method

.getChatAdmins answer/api method takes argument: chat id you want to get admins to (optional in answer method, current chat id by default)

If you want to know what arguments an API method takes, see the IDE hint

Returns array of on success

Get chat member count

To get chat member count, use .getChatMemberCount answer/api method

.getChatMemberCount answer/api method takes argument: chat id you want to get member count to (optional in answer method, current chat id by default)

If you want to know what arguments an API method takes, see the IDE hint

Returns number on success

Get chat member

To get chat member, use .getChatMember answer/api method

.getChatMember answer method take arguments:

Argument
Description
Required
1

User id you want to get

Optional. Current user id by default

2

Chat id you want to get member to

Optional. Current chat id by default

If you want to know what arguments an API method takes, see the IDE hint

Leave chat

You can leave chat using Leave class-method or .leave answer/api method

Leave class-method or .leave answer/api method takes argument: chat id you want to leave to as argument (optional in answer method, current chat id by default)

If you want to know what arguments an API method takes, see the IDE hint

app.controller.ts
import { Controller, Leave, OnCommand } from 'nestgram';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @OnCommand('leave')
  leaveChat() {
    return new Leave();
  }
}

You can read more about subscription checking

Returns on success

🤖
IChat
ChatMember
here
ChatMember