ToggleDialogPinRequest
Only users can use this request. See code examples.
---functions--- messages.toggleDialogPin#a731e257 flags:# pinned:flags.0?true peer:InputDialogPeer = Bool
Returns
| Bool |
This type has no instances available.
Parameters
| peer | InputDialogPeer | Anything entity-like will work if the library can find its Input version (e.g., usernames, Peer, User or Channel objects, etc.). |
| pinned | flag | This argument defaults to None and can be omitted. |
Known RPC errors
This request can cause 3 known errors:
PeerHistoryEmptyError | . |
PeerIdInvalidError | An invalid Peer was used. Make sure to pass the right peer type and that the value is valid (for instance, bots cannot start conversations). |
PinnedDialogsTooMuchError | Too many pinned dialogs. |
You can import these from telethon.errors.
Example
from telethon.sync import TelegramClient
from telethon import functions, types
with TelegramClient(name, api_id, api_hash) as client:
result = client(functions.messages.ToggleDialogPinRequest(
peer='username',
pinned=True
))
print(result)