messages.toggleDialogPin

Pin/unpin a dialog

Example

Javascript

const {Api, TelegramClient} = require('telegram');
const {StringSession} = require('telegram/sessions');

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.messages.toggleDialogPin({
        pinned: true,
        peer: new Api.InputDialogPeer({...}),
        }));
    console.log(result); // prints the result
})();

TypeScript

import {Api, TelegramClient} from 'telegram';
import {StringSession} from 'telegram/sessions';

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result: Api.Bool = await client.invoke(new Api.messages.toggleDialogPin({
        pinned: true,
        peer: new Api.InputDialogPeer({...}),
        }));
    console.log(result); // prints the result
})();

TL schema

boolFalse#bc799737 = Bool;
boolTrue#997275b5 = Bool;
---functions---
messages.toggleDialogPin#a731e257 flags:# pinned:flags.0?true peer:InputDialogPeer = Bool;

Parameters

Name	Type	Description
flags	#	Flags, see TL conditional fields
pinned	flags.0?true	Whether to pin or unpin the dialog
peer	InputDialogPeer	The dialog to pin

Result

Bool

Possible errors

Code	Type	Description
400	PEER_ID_INVALID	The provided peer id is invalid

Can bots use this methd ?

yes

Related pages