payments.ToggleStarGiftsPinnedToTop

class pyrogram.raw.functions.payments.ToggleStarGiftsPinnedToTop

Pins a received gift on top of the profile of the user or owned channels by using payments.toggleStarGiftsPinnedToTop.

Details:

Layer: 227
ID: 1513E7B0

Parameters:

peer (InputPeer) – The peer where to pin the gift.
stargift (List of InputSavedStarGift) – The gift to pin.

Returns:

bool

TL Schema

payments.toggleStarGiftsPinnedToTop#1513e7b0
peer:InputPeer
stargift:Vector<InputSavedStarGift>

= Bool

Parameter Tree

ToggleStarGiftsPinnedToTop
├── peer → InputPeer
│   ├── InputPeerEmpty
│   ├── InputPeerSelf
│   ├── InputPeerChat
│   │   └── chat_id → long
│   ├── InputPeerUser
│   │   ├── user_id → long
│   │   └── access_hash → long
│   ├── InputPeerChannel
│   │   ├── channel_id → long
│   │   └── access_hash → long
│   ├── InputPeerUserFromMessage
│   │   ├── peer → InputPeer
│   │   │   ├── InputPeerEmpty
│   │   │   ├── InputPeerSelf
│   │   │   ├── InputPeerChat
│   │   │   ├── InputPeerUser
│   │   │   ├── InputPeerChannel
│   │   │   ├── InputPeerUserFromMessage
│   │   │   └── InputPeerChannelFromMessage
│   │   ├── msg_id → int
│   │   └── user_id → long
│   └── InputPeerChannelFromMessage
│       ├── peer → InputPeer
│       │   ├── InputPeerEmpty
│       │   ├── InputPeerSelf
│       │   ├── InputPeerChat
│       │   ├── InputPeerUser
│       │   ├── InputPeerChannel
│       │   ├── InputPeerUserFromMessage
│       │   └── InputPeerChannelFromMessage
│       ├── msg_id → int
│       └── channel_id → long
└── stargift → Vector < InputSavedStarGift >
├── InputSavedStarGiftUser
│   └── msg_id → int
├── InputSavedStarGiftChat
│   ├── peer → InputPeer
│   │   ├── InputPeerEmpty
│   │   ├── InputPeerSelf
│   │   ├── InputPeerChat
│   │   ├── InputPeerUser
│   │   ├── InputPeerChannel
│   │   ├── InputPeerUserFromMessage
│   │   └── InputPeerChannelFromMessage
│   └── saved_id → long
└── InputSavedStarGiftSlug
└── slug → string

Example

await app.invoke(
    ToggleStarGiftsPinnedToTop(
        peer=await app.resolve_peer(chat_id),
        stargift=[
                InputSavedStarGiftUser(msg_id=0)
            ],
    )
)