messages.ToggleDialogPin

class pyrogram.raw.functions.messages.ToggleDialogPin

Pin/unpin a dialog

Details:

  • Layer: 227

  • ID: A731E257

Parameters:

  • peer (InputDialogPeer) – The dialog to pin

  • pinned (bool, optional) – Whether to pin or unpin the dialog

Returns:

bool

TL Schema

messages.toggleDialogPin#a731e257
flags:#
pinned:flags.0?true
peer:InputDialogPeer

= Bool

Parameter Tree

ToggleDialogPin
├── pinned → true (optional)
└── peer → InputDialogPeer
├── InputDialogPeer
│ └── peer → InputPeer
│ ├── InputPeerEmpty
│ ├── InputPeerSelf
│ ├── InputPeerChat
│ ├── InputPeerUser
│ ├── InputPeerChannel
│ ├── InputPeerUserFromMessage
│ └── InputPeerChannelFromMessage
└── InputDialogPeerFolder
└── folder_id → int

Example

await app.invoke(
    ToggleDialogPin(
        pinned=None,
        peer=InputDialogPeer(peer=await app.resolve_peer(chat_id)),
    )
)