MadelineProto/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md
2017-12-11 12:12:38 +01:00

1.4 KiB

title description
messages.toggleDialogPin messages.toggleDialogPin parameters, return type and example

Method: messages.toggleDialogPin

Back to methods index

Parameters:

Name Type Required
pinned Bool Optional
peer InputPeer Yes

Return type: Bool

Can bots use this method: NO

Errors this method can return:

Error Description
PEER_ID_INVALID The provided peer id is invalid

Example:

$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
    $MadelineProto->phone_login($number);
    $code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
    $MadelineProto->complete_phone_login($code);
}

$Bool = $MadelineProto->messages->toggleDialogPin(['pinned' => Bool, 'peer' => InputPeer, ]);

Or, if you're using the PWRTelegram HTTP API:

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/messages.toggleDialogPin

Parameters:

pinned - Json encoded Bool

peer - Json encoded InputPeer

Or, if you're into Lua:

Bool = messages.toggleDialogPin({pinned=Bool, peer=InputPeer, })