danog/MadelineProto
1
0
Fork 0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-02 16:17:46 +01:00
Code Issues Projects Releases Wiki Activity
a226434c9e
MadelineProto/src/InternalDoc.php

1694 lines
56 KiB
PHP
Raw Normal View History

New API
2023-01-27 14:36:54 +01:00
<?php declare(strict_types=1);
Refactor public API
2023-01-27 14:20:47 +01:00
/**
* This file is automatically generated by the build_docs.php file
* and is used only for autocompletion in multiple IDEs
* don't modify it manually.
*/
namespace danog\MadelineProto;
abstract class InternalDoc
{
New API
2023-01-27 14:36:54 +01:00
protected APIWrapper $wrapper;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Auth $auth */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $auth;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Account $account */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $account;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Users $users */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $users;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Contacts $contacts */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $contacts;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Messages $messages */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $messages;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Updates $updates */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $updates;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Photos $photos */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $photos;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Upload $upload */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $upload;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Help $help */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $help;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Channels $channels */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $channels;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Bots $bots */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $bots;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Payments $payments */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $payments;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Stickers $stickers */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $stickers;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Phone $phone */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $phone;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Langpack $langpack */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $langpack;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Folders $folders */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $folders;
/** @var \danog\MadelineProto\Namespace\AbstractAPI&\danog\MadelineProto\Namespace\Stats $stats */
public readonly \danog\MadelineProto\Namespace\AbstractAPI $stats;
Refactor public API
2023-01-27 14:20:47 +01:00
New API
2023-01-27 14:36:54 +01:00
/**
* Export APIFactory instance with the specified namespace.
Psalm fixes
2023-01-27 14:42:41 +01:00
* @psalm-suppress InaccessibleProperty
New API
2023-01-27 14:36:54 +01:00
*/
protected function exportNamespaces(): void
{
$this->auth ??= new \danog\MadelineProto\Namespace\AbstractAPI('auth');
$this->auth->setWrapper($this->wrapper);
$this->account ??= new \danog\MadelineProto\Namespace\AbstractAPI('account');
$this->account->setWrapper($this->wrapper);
$this->users ??= new \danog\MadelineProto\Namespace\AbstractAPI('users');
$this->users->setWrapper($this->wrapper);
$this->contacts ??= new \danog\MadelineProto\Namespace\AbstractAPI('contacts');
$this->contacts->setWrapper($this->wrapper);
$this->messages ??= new \danog\MadelineProto\Namespace\AbstractAPI('messages');
$this->messages->setWrapper($this->wrapper);
$this->updates ??= new \danog\MadelineProto\Namespace\AbstractAPI('updates');
$this->updates->setWrapper($this->wrapper);
$this->photos ??= new \danog\MadelineProto\Namespace\AbstractAPI('photos');
$this->photos->setWrapper($this->wrapper);
$this->upload ??= new \danog\MadelineProto\Namespace\AbstractAPI('upload');
$this->upload->setWrapper($this->wrapper);
$this->help ??= new \danog\MadelineProto\Namespace\AbstractAPI('help');
$this->help->setWrapper($this->wrapper);
$this->channels ??= new \danog\MadelineProto\Namespace\AbstractAPI('channels');
$this->channels->setWrapper($this->wrapper);
$this->bots ??= new \danog\MadelineProto\Namespace\AbstractAPI('bots');
$this->bots->setWrapper($this->wrapper);
$this->payments ??= new \danog\MadelineProto\Namespace\AbstractAPI('payments');
$this->payments->setWrapper($this->wrapper);
$this->stickers ??= new \danog\MadelineProto\Namespace\AbstractAPI('stickers');
$this->stickers->setWrapper($this->wrapper);
$this->phone ??= new \danog\MadelineProto\Namespace\AbstractAPI('phone');
$this->phone->setWrapper($this->wrapper);
$this->langpack ??= new \danog\MadelineProto\Namespace\AbstractAPI('langpack');
$this->langpack->setWrapper($this->wrapper);
$this->folders ??= new \danog\MadelineProto\Namespace\AbstractAPI('folders');
$this->folders->setWrapper($this->wrapper);
$this->stats ??= new \danog\MadelineProto\Namespace\AbstractAPI('stats');
$this->stats->setWrapper($this->wrapper);
}
Refactor public API
2023-01-27 14:20:47 +01:00
/**
New API
2023-01-27 14:36:54 +01:00
* Convert MTProto parameters to bot API parameters.
*
* @param array $data Data
*/
Refactor public API
2023-01-27 14:20:47 +01:00
public function MTProtoToBotAPI(array $data)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($data);
}
/**
* MTProto to TD params.
*
* @param mixed $params Params
*/
public function MTProtoToTd(mixed &$params)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params);
}
/**
* MTProto to TDCLI params.
*
* @param mixed $params Params
*/
public function MTProtoToTdcli(mixed $params)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params);
}
/**
* Accept call.
*
* @param array $call Call
*/
public function acceptCall(array $call)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($call);
}
/**
* Accept secret chat.
*
* @param array $params Secret chat ID
*/
New API
2023-01-27 14:36:54 +01:00
public function acceptSecretChat(array $params): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($params);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Add user info.
*
* @param array $user User info
*/
New API
2023-01-27 14:36:54 +01:00
public function addUser(array $user): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($user);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Call promise $b after promise $a.
*
* @deprecated Coroutines are deprecated since amp v3
Psalm fixes
2023-01-27 14:42:41 +01:00
* @param \Generator|\Amp\Future $a Promise A
* @param \Generator|\Amp\Future $b Promise B
Refactor public API
2023-01-27 14:20:47 +01:00
* @psalm-suppress InvalidScope
* @return Amp\Future
*/
public static function after(\Generator|\Amp\Future $a, \Generator|\Amp\Future $b): \Amp\Future
{
return \danog\MadelineProto\AsyncTools::after($a, $b);
}
/**
* Returns a promise that succeeds when all promises succeed, and fails if any promise fails.
* Returned promise succeeds with an array of values used to succeed each contained promise, with keys corresponding to the array of promises.
*
* @deprecated Coroutines are deprecated since amp v3
Psalm fixes
2023-01-27 14:42:41 +01:00
* @param array<(\Generator|\Amp\Future)> $promises Promises
Refactor public API
2023-01-27 14:20:47 +01:00
*/
public static function all(array $promises)
{
return \danog\MadelineProto\AsyncTools::all($promises);
}
/**
* Returns a promise that is resolved when all promises are resolved. The returned promise will not fail.
*
* @deprecated Coroutines are deprecated since amp v3
* @param array<(Future|Generator)> $promises Promises
*/
public static function any(array $promises)
{
return \danog\MadelineProto\AsyncTools::any($promises);
}
/**
* Create array.
*
* @param mixed ...$params Params
*/
public static function arr(mixed ...$params): array
{
return \danog\MadelineProto\Tools::arr(...$params);
}
/**
* base64URL decode.
*
* @param string $data Data to decode
*/
public static function base64urlDecode(string $data): string
{
return \danog\MadelineProto\Tools::base64urlDecode($data);
}
/**
* Base64URL encode.
*
* @param string $data Data to encode
*/
public static function base64urlEncode(string $data): string
{
return \danog\MadelineProto\Tools::base64urlEncode($data);
}
/**
* Convert bot API parameters to MTProto parameters.
*
* @param array $arguments Arguments
*/
public function botAPIToMTProto(array $arguments)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($arguments);
}
/**
* Login as bot.
*
* @param string $token Bot token
*/
public function botLogin(string $token)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($token);
}
/**
* Convert generator, promise or any other value to a promise.
*
* @deprecated Coroutines are deprecated since amp v3
* @template TReturn
* @param Generator<mixed, mixed, mixed, TReturn>|Future<TReturn>|TReturn $promise
Psalm fixes
2023-01-27 14:42:41 +01:00
* @return \Amp\Future<TReturn>
Refactor public API
2023-01-27 14:20:47 +01:00
*/
public static function call(mixed $promise): \Amp\Future
{
return \danog\MadelineProto\AsyncTools::call($promise);
}
/**
* Call promise in background.
*
* @deprecated Coroutines are deprecated since amp v3
Psalm fixes
2023-01-27 14:42:41 +01:00
* @param \Generator|\Amp\Future $promise Promise to resolve
* @param ?\\Generator|\Amp\Future $actual Promise to resolve instead of $promise
Refactor public API
2023-01-27 14:20:47 +01:00
* @param string $file File
* @psalm-suppress InvalidScope
*/
public static function callFork(\Generator|\Amp\Future $promise, $actual = null, string $file = ''): mixed
{
return \danog\MadelineProto\AsyncTools::callFork($promise, $actual, $file);
}
/**
* Call promise in background, deferring execution.
*
* @deprecated Coroutines are deprecated since amp v3
Psalm fixes
2023-01-27 14:42:41 +01:00
* @param \Generator|\Amp\Future $promise Promise to resolve
Refactor public API
2023-01-27 14:20:47 +01:00
*/
public static function callForkDefer(\Generator|\Amp\Future $promise): void
{
New API
2023-01-27 14:36:54 +01:00
\danog\MadelineProto\AsyncTools::callForkDefer($promise);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Get call status.
*
* @param int $id Call ID
*/
public function callStatus(int $id)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($id);
}
/**
* Close connection with client, connected via web.
*
* @param string $message Message
*/
public static function closeConnection(string $message): void
{
New API
2023-01-27 14:36:54 +01:00
\danog\MadelineProto\Tools::closeConnection($message);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Complete 2FA login.
*
* @param string $password Password
*/
public function complete2faLogin(string $password)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($password);
}
/**
* Complete call handshake.
*
* @param array $params Params
*/
public function completeCall(array $params)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params);
}
/**
* Complet user login using login code.
*
* @param string $code Login code
*/
public function completePhoneLogin(string $code)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($code);
}
/**
* Complete signup to Telegram.
*
* @param string $first_name First name
* @param string $last_name Last name
*/
public function completeSignup(string $first_name, string $last_name = '')
{
return $this->wrapper->getAPI()->{__FUNCTION__}($first_name, $last_name);
}
/**
* Confirm call.
*
* @param array $params Params
*/
public function confirmCall(array $params)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params);
}
/**
* Connects to all datacenters and if necessary creates authorization keys, binds them and writes client info.
*
* @param boolean $reconnectAll Whether to reconnect to all DCs
*/
New API
2023-01-27 14:36:54 +01:00
public function connectToAllDcs(bool $reconnectAll = true): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($reconnectAll);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Discard call.
*
* @param array $call Call
* @param array $rating Rating
* @param boolean $need_debug Need debug?
*/
New API
2023-01-27 14:36:54 +01:00
public function discardCall(array $call, array $reason, array $rating = [
], bool $need_debug = true)
Refactor public API
2023-01-27 14:20:47 +01:00
{
return $this->wrapper->getAPI()->{__FUNCTION__}($call, $reason, $rating, $need_debug);
}
/**
* Discard secret chat.
*
* @param int $chat Secret chat ID
*/
New API
2023-01-27 14:36:54 +01:00
public function discardSecretChat(int $chat): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($chat);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Download file to browser.
*
* Supports HEAD requests and content-ranges for parallel and resumed downloads.
*
* @param array|string|FileCallbackInterface $messageMedia File to download
* @param null|callable $cb Status callback (can also use FileCallback)
* @param null|int $size Size of file to download, required for bot API file IDs.
* @param null|string $mime MIME type of file to download, required for bot API file IDs.
* @param null|string $name Name of file to download, required for bot API file IDs.
*/
New API
2023-01-27 14:36:54 +01:00
public function downloadToBrowser(\danog\MadelineProto\FileCallbackInterface|array|string $messageMedia, ?callable $cb = null, ?int $size = null, ?string $name = null, ?string $mime = null): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($messageMedia, $cb, $size, $name, $mime);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Download file to callable.
* The callable must accept two parameters: string $payload, int $offset
* The callable will be called (possibly out of order, depending on the value of $seekable).
*
* @param mixed $messageMedia File to download
* @param callable|FileCallbackInterface $callable Chunk callback
* @param callable $cb Status callback (DEPRECATED, use FileCallbackInterface)
* @param bool $seekable Whether the callable can be called out of order
* @param int $offset Offset where to start downloading
* @param int $end Offset where to stop downloading (inclusive)
* @param int $part_size Size of each chunk
*/
public function downloadToCallable(mixed $messageMedia, callable $callable, ?callable $cb = null, bool $seekable = true, int $offset = 0, int $end = -1, ?int $part_size = null)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($messageMedia, $callable, $cb, $seekable, $offset, $end, $part_size);
}
/**
* Download file to directory.
*
* @param mixed $messageMedia File to download
* @param string|FileCallbackInterface $dir Directory where to download the file
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
*/
public function downloadToDir(mixed $messageMedia, \danog\MadelineProto\FileCallbackInterface|string $dir, ?callable $cb = null)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($messageMedia, $dir, $cb);
}
/**
* Download file.
*
* @param mixed $messageMedia File to download
* @param string|FileCallbackInterface $file Downloaded file path
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
*/
public function downloadToFile(mixed $messageMedia, \danog\MadelineProto\FileCallbackInterface|string $file, ?callable $cb = null)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($messageMedia, $file, $cb);
}
/**
* Download file to amphp/http-server response.
*
* Supports HEAD requests and content-ranges for parallel and resumed downloads.
*
* @param array|string|FileCallbackInterface $messageMedia File to download
* @param ServerRequest $request Request
* @param callable $cb Status callback (can also use FileCallback)
* @param null|int $size Size of file to download, required for bot API file IDs.
* @param null|string $name Name of file to download, required for bot API file IDs.
* @param null|string $mime MIME type of file to download, required for bot API file IDs.
*/
public function downloadToResponse(\danog\MadelineProto\FileCallbackInterface|array|string $messageMedia, \Amp\Http\Server\Request $request, ?callable $cb = null, ?int $size = null, ?string $mime = null, ?string $name = null)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($messageMedia, $request, $cb, $size, $mime, $name);
}
/**
* Download file to stream.
*
* @param mixed $messageMedia File to download
* @param mixed|FileCallbackInterface|resource|WritableStream $stream Stream where to download file
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param int $offset Offset where to start downloading
* @param int $end Offset where to end download
*/
public function downloadToStream(mixed $messageMedia, mixed $stream, ?callable $cb = null, int $offset = 0, int $end = -1)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($messageMedia, $stream, $cb, $offset, $end);
}
/**
* Asynchronously write to stdout/browser.
*
* @param string $string Message to echo
*/
public static function echo(string $string): void
{
New API
2023-01-27 14:36:54 +01:00
\danog\MadelineProto\AsyncTools::echo($string);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Get final element of array.
*
* @param array $what Array
*/
public static function end(array $what)
{
return \danog\MadelineProto\Tools::end($what);
}
/**
* Export authorization.
*
*/
public function exportAuthorization()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Extract file info from bot API message.
*
* @param array $info Bot API message object
* @return ?array
*/
public static function extractBotAPIFile(array $info): ?array
{
return \danog\MadelineProto\MTProto::extractBotAPIFile($info);
}
/**
* Extract a message constructor from an Updates constructor.
*/
public function extractMessage(array $updates)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($updates);
}
/**
* Extract a message ID from an Updates constructor.
*/
public function extractMessageId(array $updates)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($updates);
}
/**
* Extract an update message constructor from an Updates constructor.
*/
public function extractMessageUpdate(array $updates)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($updates);
}
/**
* Extract Update constructors from an Updates constructor.
*
*/
public function extractUpdates(array $updates)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($updates);
}
/**
* Get contents of remote file asynchronously.
*
* @param string $url URL
*/
public function fileGetContents(string $url)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($url);
}
/**
* Returns a promise that succeeds when the first promise succeeds, and fails only if all promises fail.
*
* @deprecated Coroutines are deprecated since amp v3
* @param array<(Future|Generator)> $promises Promises
*/
public static function first(array $promises)
{
return \danog\MadelineProto\AsyncTools::first($promises);
}
/**
* Asynchronously lock a file
* Resolves with a callbable that MUST eventually be called in order to release the lock.
*
* @param string $file File to lock
* @param integer $operation Locking mode
* @param float $polling Polling interval
* @param ?Cancellation $token Cancellation token
* @param ?Closure $failureCb Failure callback, called only once if the first locking attempt fails.
* @return ($token is null ? (Closure(): void) : ((Closure(): void)|null))
*/
public static function flock(string $file, int $operation, float $polling = 0.1, ?\Amp\Cancellation $token = null, ?\Closure $failureCb = null): ?\Closure
{
return \danog\MadelineProto\AsyncTools::flock($file, $operation, $polling, $token, $failureCb);
}
/**
* Convert bot API channel ID to MTProto channel ID.
*
* @param int $id Bot API channel ID
*/
public static function fromSupergroup(int $id): int
{
return \danog\MadelineProto\MTProto::fromSupergroup($id);
}
/**
* When were full info for this chat last cached.
*
* @param mixed $id Chat ID
*/
public function fullChatLastUpdated(mixed $id)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($id);
}
/**
* Get info about the logged-in user, not cached.
*/
public function fullGetSelf()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Generate MTProto vector hash.
*
* @param array $ints IDs
* @return string Vector hash
*/
public static function genVectorHash(array $ints): string
{
return \danog\MadelineProto\Tools::genVectorHash($ints);
}
/**
* Get full list of MTProto and API methods.
*/
public function getAllMethods()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get authorization info.
*/
public function getAuthorization()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get cached server-side config.
*/
public function getCachedConfig()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get call info.
*
* @param int $call Call ID
*/
public function getCall(int $call)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($call);
}
/**
* Store RSA keys for CDN datacenters.
*/
New API
2023-01-27 14:36:54 +01:00
public function getCdnConfig(): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}();
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Get cached (or eventually re-fetch) server-side config.
*
* @param array $config Current config
*/
New API
2023-01-27 14:36:54 +01:00
public function getConfig(array $config = [
])
Refactor public API
2023-01-27 14:20:47 +01:00
{
return $this->wrapper->getAPI()->{__FUNCTION__}($config);
}
/**
* Get async DNS client.
*/
public function getDNSClient()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get all datacenter connections.
*
*/
public function getDataCenterConnections()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get main DC ID.
*
*/
public function getDataCenterId()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get diffie-hellman configuration.
*/
public function getDhConfig()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get dialog peers.
*
* @param boolean $force Whether to refetch all dialogs ignoring cache
*/
public function getDialogs(bool $force = true)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($force);
}
/**
* Get download info of file
* Returns an array with the following structure:.
*
* `$info['ext']` - The file extension
* `$info['name']` - The file name, without the extension
* `$info['mime']` - The file mime type
* `$info['size']` - The file size
*
* @param mixed $messageMedia File ID
*/
public function getDownloadInfo(mixed $messageMedia)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($messageMedia);
}
/**
* Get event handler.
*/
public function getEventHandler()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get extension from file location.
*
* @param mixed $location File location
* @param string $default Default extension
*/
public static function getExtensionFromLocation(mixed $location, string $default): string
{
return \danog\MadelineProto\TL\Conversion\Extension::getExtensionFromLocation($location, $default);
}
/**
* Get extension from mime type.
*
* @param string $mime MIME type
*/
public static function getExtensionFromMime(string $mime): string
{
return \danog\MadelineProto\TL\Conversion\Extension::getExtensionFromMime($mime);
}
/**
* Get info about file.
*
* @param mixed $constructor File ID
*/
public function getFileInfo(mixed $constructor)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($constructor);
}
/**
* Get folder ID from object.
*
* @param mixed $id Object
* @return ?int
*/
public static function getFolderId(mixed $id): ?int
{
return \danog\MadelineProto\MTProto::getFolderId($id);
}
/**
* Get full info of all dialogs.
*
* @param boolean $force Whether to refetch all dialogs ignoring cache
*/
public function getFullDialogs(bool $force = true)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($force);
}
/**
* Get full info about peer, returns an FullInfo object.
*
* @param mixed $id Peer
* @see https://docs.madelineproto.xyz/FullInfo.html
*/
public function getFullInfo(mixed $id)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($id);
}
/**
* Get async HTTP client.
*/
public function getHTTPClient()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get current password hint.
*/
public function getHint()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get bot API ID from peer object.
*
* @param mixed $id Peer
*/
public function getId(mixed $id)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($id);
}
/**
* Get info about peer, returns an Info object.
*
* @param mixed $id Peer
* @param MTProto::INFO_TYPE_* $type Whether to generate an Input*, an InputPeer or the full set of constructors
* @see https://docs.madelineproto.xyz/Info.html
* @return mixed
* InputPeer: array{_: string, user_id?: int, access_hash?: int, min?: bool, chat_id?: int, channel_id?: int},
* Peer: array{_: string, user_id?: int, chat_id?: int, channel_id?: int},
* DialogPeer: array{_: string, peer: array{_: string, user_id?: int, chat_id?: int, channel_id?: int}},
* NotifyPeer: array{_: string, peer: array{_: string, user_id?: int, chat_id?: int, channel_id?: int}},
* InputDialogPeer: array{_: string, peer: array{_: string, user_id?: int, access_hash?: int, min?: bool, chat_id?: int, channel_id?: int}},
* InputNotifyPeer: array{_: string, peer: array{_: string, user_id?: int, access_hash?: int, min?: bool, chat_id?: int, channel_id?: int}},
* bot_api_id: int|string,
* user_id?: int,
* chat_id?: int,
* channel_id?: int,
* InputUser?: array{_: string, user_id?: int, access_hash?: int, min?: bool},
* InputChannel?: array{_: string, channel_id: int, access_hash: int, min: bool},
* type: string
Psalm fixes
2023-01-27 14:42:41 +01:00
* } : ($type is MTProto::INFO_TYPE_ID ? int : array{_: string, user_id?: int, access_hash?: int, min?: bool, chat_id?: int, channel_id?: int}|array{_: string, user_id?: int, access_hash?: int, min?: bool}|array{_: string, channel_id: int, access_hash: int, min: bool}))
Refactor public API
2023-01-27 14:20:47 +01:00
*/
public function getInfo(mixed $id, int $type = \danog\MadelineProto\MTProto::INFO_TYPE_ALL)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($id, $type);
}
/**
* Get logger.
*/
public function getLogger()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get TL namespaces.
*/
public function getMethodNamespaces()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get namespaced methods (method => namespace).
*/
public function getMethodsNamespaced()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get mime type from buffer.
*
* @param string $buffer Buffer
*/
public static function getMimeFromBuffer(string $buffer): string
{
return \danog\MadelineProto\TL\Conversion\Extension::getMimeFromBuffer($buffer);
}
/**
* Get mime type from file extension.
*
* @param string $extension File extension
* @param string $default Default mime type
*/
public static function getMimeFromExtension(string $extension, string $default): string
{
return \danog\MadelineProto\TL\Conversion\Extension::getMimeFromExtension($extension, $default);
}
/**
* Get mime type of file.
*
* @param string $file File
*/
public static function getMimeFromFile(string $file): string
{
return \danog\MadelineProto\TL\Conversion\Extension::getMimeFromFile($file);
}
/**
* Get download info of the propic of a user
* Returns an array with the following structure:.
*
* `$info['ext']` - The file extension
* `$info['name']` - The file name, without the extension
* `$info['mime']` - The file mime type
* `$info['size']` - The file size
*/
public function getPropicInfo($data)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($data);
}
/**
* Get PSR logger.
*/
public function getPsrLogger()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get full info about peer (including full list of channel members), returns a Chat object.
*
* @param mixed $id Peer
* @see https://docs.madelineproto.xyz/Chat.html
*/
public function getPwrChat(mixed $id, bool $fullfetch = true)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($id, $fullfetch);
}
/**
* Get secret chat.
*
* @param array|int $chat Secret chat ID
*/
public function getSecretChat(array|int $chat)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($chat);
}
/**
* Get info about the logged-in user, cached.
*
* Use fullGetSelf to bypass the cache.
*/
public function getSelf()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Return current settings.
*/
public function getSettings()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get sponsored messages for channel.
* This method will return an array of [sponsored message objects](https://docs.madelineproto.xyz/API_docs/constructors/sponsoredMessage.html).
*
* See [the API documentation](https://core.telegram.org/api/sponsored-messages) for more info on how to handle sponsored messages.
*
* @param int|string|array $peer Channel ID, or Update, or Message, or Peer.
*/
public function getSponsoredMessages(array|string|int $peer)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($peer);
}
/**
* Get TL serializer.
*/
public function getTL()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Get updates.
*
* @param array{offset?: int, limit?: int, timeout?: float} $params Params
*/
New API
2023-01-27 14:36:54 +01:00
public function getUpdates(array $params = [
])
Refactor public API
2023-01-27 14:20:47 +01:00
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params);
}
/**
* Accesses a private variable from an object.
*
* @param object $obj Object
* @param string $var Attribute name
* @psalm-suppress InvalidScope
* @access public
*/
public static function getVar(object $obj, string $var)
{
return \danog\MadelineProto\Tools::getVar($obj, $var);
}
/**
* Get a message to show to the user when starting the bot.
*/
public function getWebMessage(string $message)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($message);
}
/**
* Get web template.
*/
public function getWebTemplate()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Checks whether all datacenters are authorized.
*/
public function hasAllAuth()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Check if an event handler instance is present.
*/
public function hasEventHandler()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Check if has report peers.
*/
public function hasReportPeers()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Check whether secret chat exists.
*
* @param array|int $chat Secret chat ID
*/
public function hasSecretChat(array|int $chat)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($chat);
}
/**
* Checks private property exists in an object.
*
* @param object $obj Object
* @param string $var Attribute name
* @psalm-suppress InvalidScope
* @access public
*/
public static function hasVar(object $obj, string $var): bool
{
return \danog\MadelineProto\Tools::hasVar($obj, $var);
}
/**
* Import authorization.
*
* @param array<int, string> $authorization Authorization info
* @param int $mainDcID Main DC ID
*/
public function importAuthorization(array $authorization, int $mainDcID)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($authorization, $mainDcID);
}
/**
* Inflate stripped photosize to full JPG payload.
*
* @param string $stripped Stripped photosize
* @return string JPG payload
*/
public static function inflateStripped(string $stripped): string
{
return \danog\MadelineProto\Tools::inflateStripped($stripped);
}
/**
* Initialize self-restart hack.
*/
New API
2023-01-27 14:36:54 +01:00
public function initSelfRestart(): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}();
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Whether this is altervista.
*/
public static function isAltervista(): bool
{
return \danog\MadelineProto\Tools::isAltervista();
}
/**
* Check if is array or similar (traversable && countable && arrayAccess).
*
* @param mixed $var Value to check
*/
public static function isArrayOrAlike(mixed $var): bool
{
return \danog\MadelineProto\Tools::isArrayOrAlike($var);
}
/**
* Whether we're an IPC client instance.
*/
public function isIpc()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Whether we're an IPC server process (as opposed to an event handler).
*/
public function isIpcWorker()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Returns whether the current user is a premium user, cached.
*/
public function isPremium()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Check whether provided bot API ID is a channel.
*
* @param int $id Bot API ID
*/
public static function isSupergroup(int $id): bool
{
return \danog\MadelineProto\MTProto::isSupergroup($id);
}
/**
* Logger.
*
* @param mixed $param Parameter
* @param int $level Logging level
* @param string $file File where the message originated
*/
New API
2023-01-27 14:36:54 +01:00
public function logger(mixed $param, int $level = \danog\MadelineProto\Logger::NOTICE, string $file = ''): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($param, $level, $file);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Start MadelineProto's update handling loop, or run the provided async callable.
*
* @param callable|null $callback Async callable to run
*/
public function loop(?callable $callback = null)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($callback);
}
/**
* Escape string for markdown.
*
* @param string $hwat String to escape
*/
public static function markdownEscape(string $hwat): string
{
return \danog\MadelineProto\StrTools::markdownEscape($hwat);
}
/**
* Telegram UTF-8 multibyte split.
*
* @param string $text Text
* @param integer $length Length
* @return array<string>
*/
public static function mbStrSplit(string $text, int $length): array
{
return \danog\MadelineProto\StrTools::mbStrSplit($text, $length);
}
/**
* Get Telegram UTF-8 length of string.
*
* @param string $text Text
*/
public static function mbStrlen(string $text): int
{
return \danog\MadelineProto\StrTools::mbStrlen($text);
}
/**
* Telegram UTF-8 multibyte substring.
*
* @param string $text Text to substring
* @param integer $offset Offset
* @param null|int $length Length
*/
public static function mbSubstr(string $text, int $offset, ?int $length = null): string
{
return \danog\MadelineProto\StrTools::mbSubstr($text, $offset, $length);
}
/**
* Call method and wait asynchronously for response.
*
* If the $aargs['noResponse'] is true, will not wait for a response.
*
* @param string $method Method name
* @param array|(callable(): array) $args Arguments
* @param array $aargs Additional arguments
*/
New API
2023-01-27 14:36:54 +01:00
public function methodCall(string $method, callable|array $args = [
], array $aargs = [
'msg_id' => null,
])
Refactor public API
2023-01-27 14:20:47 +01:00
{
return $this->wrapper->getAPI()->{__FUNCTION__}($method, $args, $aargs);
}
/**
* Call method and make sure it is asynchronously sent.
*
* @param string $method Method name
* @param array|(callable(): array) $args Arguments
* @param array $aargs Additional arguments
*/
New API
2023-01-27 14:36:54 +01:00
public function methodCallWrite(string $method, callable|array $args = [
], array $aargs = [
'msg_id' => null,
])
Refactor public API
2023-01-27 14:20:47 +01:00
{
return $this->wrapper->getAPI()->{__FUNCTION__}($method, $args, $aargs);
}
/**
* Escape method name.
*
* @param string $method Method name
*/
public static function methodEscape(string $method): string
{
return \danog\MadelineProto\StrTools::methodEscape($method);
}
/**
* Convert double to binary version.
*
* @param float $value Value to convert
*/
public static function packDouble(float $value): string
{
return \danog\MadelineProto\Tools::packDouble($value);
}
/**
* Convert integer to base256 signed int.
*
* @param integer $value Value to convert
*/
public static function packSignedInt(int $value): string
{
return \danog\MadelineProto\Tools::packSignedInt($value);
}
/**
* Convert integer to base256 long.
*
* @param int $value Value to convert
*/
public static function packSignedLong(int $value): string
{
return \danog\MadelineProto\Tools::packSignedLong($value);
}
/**
* Convert value to unsigned base256 int.
*
* @param int $value Value
*/
public static function packUnsignedInt(int $value): string
{
return \danog\MadelineProto\Tools::packUnsignedInt($value);
}
/**
* Check if peer is present in internal peer database.
*
* @param mixed $id Peer
*/
public function peerIsset(mixed $id)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($id);
}
/**
* Login as user.
*
* @param string $number Phone number
* @param integer $sms_type SMS type
*/
public function phoneLogin(string $number, int $sms_type = 5)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($number, $sms_type);
}
/**
* Positive modulo
* Works just like the % (modulus) operator, only returns always a postive number.
*
* @param int $a A
* @param int $b B
* @return int Modulo
*/
public static function posmod(int $a, int $b): int
{
return \danog\MadelineProto\Tools::posmod($a, $b);
}
/**
* Get random string of specified length.
*
* @param integer $length Length
* @return string Random string
*/
public static function random(int $length): string
{
return \danog\MadelineProto\Tools::random($length);
}
/**
* Get random integer.
*
* @param integer $modulus Modulus
*/
public static function randomInt(int $modulus = 0): int
{
return \danog\MadelineProto\Tools::randomInt($modulus);
}
/**
* Asynchronously read line.
*
* @param string $prompt Prompt
*/
public static function readLine(string $prompt = ''): string
{
return \danog\MadelineProto\AsyncTools::readLine($prompt);
}
/**
* Refresh full peer cache for a certain peer.
*
* @param mixed $id The peer to refresh
*/
New API
2023-01-27 14:36:54 +01:00
public function refreshFullPeerCache(mixed $id): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($id);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Refresh peer cache for a certain peer.
*
*/
New API
2023-01-27 14:36:54 +01:00
public function refreshPeerCache(mixed ...$ids): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}(...$ids);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Rekey secret chat.
*
* @param int $chat Secret chat to rekey
*/
public function rekey(int $chat)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($chat);
}
/**
* Report an error to the previously set peer.
*
* @param string $message Error to report
* @param string $parseMode Parse mode
*/
New API
2023-01-27 14:36:54 +01:00
public function report(string $message, string $parseMode = ''): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($message, $parseMode);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Request VoIP call.
*
* @param mixed $user User
*/
public function requestCall(mixed $user)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($user);
}
/**
* Request secret chat.
*
* @param mixed $user User to start secret chat with
*/
public function requestSecretChat(mixed $user)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($user);
}
/**
* Reset the update state and fetch all updates from the beginning.
*/
New API
2023-01-27 14:36:54 +01:00
public function resetUpdateState(): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}();
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* null-byte RLE decode.
*
* @param string $string Data to decode
*/
public static function rleDecode(string $string): string
{
return \danog\MadelineProto\Tools::rleDecode($string);
}
/**
* null-byte RLE encode.
*
* @param string $string Data to encode
*/
public static function rleEncode(string $string): string
{
return \danog\MadelineProto\Tools::rleEncode($string);
}
/**
* Get secret chat status.
*
* @param int $chat Chat ID
*/
public function secretChatStatus(int $chat)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($chat);
}
/**
* Set NOOP update handler, ignoring all updates.
*/
New API
2023-01-27 14:36:54 +01:00
public function setNoop(): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}();
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Set peer(s) where to send errors occurred in the event loop.
*
* @param int|string|array<int|string> $userOrId Username(s) or peer ID(s)
*/
New API
2023-01-27 14:36:54 +01:00
public function setReportPeers(array|string|int $userOrId): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($userOrId);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Sets a private variable in an object.
*
* @param object $obj Object
* @param string $var Attribute name
* @param mixed $val Attribute value
* @psalm-suppress InvalidScope
* @access public
*/
public static function setVar(object $obj, string $var, mixed &$val): void
{
New API
2023-01-27 14:36:54 +01:00
\danog\MadelineProto\Tools::setVar($obj, $var, $val);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Set web template.
*
* @param string $template Template
*/
New API
2023-01-27 14:36:54 +01:00
public function setWebTemplate(string $template): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($template);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Set webhook update handler.
*
* @param string $webhookUrl Webhook URL
*/
New API
2023-01-27 14:36:54 +01:00
public function setWebhook(string $webhookUrl): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($webhookUrl);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Setup logger.
*/
New API
2023-01-27 14:36:54 +01:00
public function setupLogger(): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}();
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Asynchronously sleep.
*
* @param float $time Number of seconds to sleep for
*/
public static function sleep(float $time): void
{
New API
2023-01-27 14:36:54 +01:00
\danog\MadelineProto\AsyncTools::sleep($time);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Resolves with a two-item array delineating successful and failed Promise results.
* The returned promise will only fail if the given number of required promises fail.
*
* @deprecated Coroutines are deprecated since amp v3
* @param array<(Future|Generator)> $promises Promises
*/
public static function some(array $promises)
{
return \danog\MadelineProto\AsyncTools::some($promises);
}
/**
* Log in to telegram (via CLI or web).
*/
public function start()
{
return $this->wrapper->getAPI()->{__FUNCTION__}();
}
/**
* Subscribe to event handler updates for a channel/supergroup we're not a member of.
*
*/
public function subscribeToUpdates(mixed $channel)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($channel);
}
/**
* Convert TD to MTProto parameters.
*
* @param array $params Parameters
*/
public function tdToMTProto(array $params)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params);
}
/**
* Convert TD parameters to tdcli.
*
* @param mixed $params Parameters
*/
public function tdToTdcli(mixed $params)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params);
}
/**
* Convert tdcli parameters to tdcli.
*
* @param mixed $params Params
* @param array $key Key
*/
public function tdcliToTd(&$params, ?array $key = null)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($params, $key);
}
/**
* Create an artificial timeout for any \Generator or Promise.
*
* @deprecated Coroutines are deprecated since amp v3
* @param int $timeout In milliseconds
*/
public static function timeout(\Generator|\Amp\Future $promise, int $timeout): mixed
{
return \danog\MadelineProto\AsyncTools::timeout($promise, $timeout);
}
/**
* Creates an artificial timeout for any `Promise`.
*
* If the promise is resolved before the timeout expires, the result is returned
*
* If the timeout expires before the promise is resolved, a default value is returned
*
* @deprecated Coroutines are deprecated since amp v3
* @template TReturnAlt
* @template TReturn
Psalm fixes
2023-01-27 14:42:41 +01:00
* @template TGenerator of \Generator<mixed, mixed, mixed, TReturn>
* @param \Amp\Future<TReturn>|TGenerator $promise Promise to which the timeout is applied.
Refactor public API
2023-01-27 14:20:47 +01:00
* @param int $timeout Timeout in milliseconds.
* @param TReturnAlt $default
* @return TReturn|TReturnAlt
*/
public static function timeoutWithDefault($promise, int $timeout, $default = null): mixed
{
return \danog\MadelineProto\AsyncTools::timeoutWithDefault($promise, $timeout, $default);
}
/**
* Convert to camelCase.
*
* @param string $input String
*/
public static function toCamelCase(string $input): string
{
return \danog\MadelineProto\StrTools::toCamelCase($input);
}
/**
* Convert to snake_case.
*
* @param string $input String
*/
public static function toSnakeCase(string $input): string
{
return \danog\MadelineProto\StrTools::toSnakeCase($input);
}
/**
* Convert MTProto channel ID to bot API channel ID.
*
* @param int $id MTProto channel ID
*/
public static function toSupergroup(int $id): int
{
return \danog\MadelineProto\MTProto::toSupergroup($id);
}
/**
* Escape type name.
*
* @param string $type String to escape
*/
public static function typeEscape(string $type): string
{
return \danog\MadelineProto\StrTools::typeEscape($type);
}
/**
* Unpack binary double.
*
* @param string $value Value to unpack
*/
public static function unpackDouble(string $value): float
{
return \danog\MadelineProto\Tools::unpackDouble($value);
}
/**
* Unpack bot API file ID.
*
* @param string $fileId Bot API file ID
*/
public function unpackFileId(string $fileId)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($fileId);
}
/**
* Unpack base256 signed int.
*
* @param string $value base256 int
*/
public static function unpackSignedInt(string $value): int
{
return \danog\MadelineProto\Tools::unpackSignedInt($value);
}
/**
* Unpack base256 signed long.
*
* @param string $value base256 long
*/
public static function unpackSignedLong(string $value): int
{
return \danog\MadelineProto\Tools::unpackSignedLong($value);
}
/**
* Unpack base256 signed long to string.
*
* @param string|int|array $value base256 long
*/
public static function unpackSignedLongString(array|string|int $value): string
{
return \danog\MadelineProto\Tools::unpackSignedLongString($value);
}
/**
* Unset event handler.
*
*/
New API
2023-01-27 14:36:54 +01:00
public function unsetEventHandler(): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}();
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Update the 2FA password.
*
* The params array can contain password, new_password, email and hint params.
*
* @param array $params The params
*/
New API
2023-01-27 14:36:54 +01:00
public function update2fa(array $params): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($params);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Parse, update and store settings.
*
* @param SettingsAbstract $settings Settings
*/
New API
2023-01-27 14:36:54 +01:00
public function updateSettings(\danog\MadelineProto\SettingsAbstract $settings): void
Refactor public API
2023-01-27 14:20:47 +01:00
{
New API
2023-01-27 14:36:54 +01:00
$this->wrapper->getAPI()->{__FUNCTION__}($settings);
Refactor public API
2023-01-27 14:20:47 +01:00
}
/**
* Upload file.
*
* @param FileCallbackInterface|string|array $file File, URL or Telegram file to upload
* @param string $fileName File name
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $encrypted Whether to encrypt file for secret chats
*/
public function upload(\danog\MadelineProto\FileCallbackInterface|array|string $file, string $fileName = '', ?callable $cb = null, bool $encrypted = false)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($file, $fileName, $cb, $encrypted);
}
/**
* Upload file to secret chat.
*
* @param FileCallbackInterface|string|array $file File, URL or Telegram file to upload
* @param string $fileName File name
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
*/
public function uploadEncrypted(\danog\MadelineProto\FileCallbackInterface|array|string $file, string $fileName = '', ?callable $cb = null)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($file, $fileName, $cb);
}
/**
* Upload file from callable.
*
* The callable must accept two parameters: int $offset, int $size
* The callable must return a string with the contest of the file at the specified offset and size.
*
* @param mixed $callable Callable
* @param integer $size File size
* @param string $mime Mime type
* @param string $fileName File name
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $seekable Whether chunks can be fetched out of order
* @param boolean $encrypted Whether to encrypt file for secret chats
*/
public function uploadFromCallable(callable $callable, int $size, string $mime, string $fileName = '', ?callable $cb = null, bool $seekable = true, bool $encrypted = false)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($callable, $size, $mime, $fileName, $cb, $seekable, $encrypted);
}
/**
* Upload file from stream.
*
* @param mixed $stream PHP resource or AMPHP async stream
* @param integer $size File size
* @param string $mime Mime type
* @param string $fileName File name
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $encrypted Whether to encrypt file for secret chats
*/
public function uploadFromStream(mixed $stream, int $size, string $mime, string $fileName = '', ?callable $cb = null, bool $encrypted = false)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($stream, $size, $mime, $fileName, $cb, $encrypted);
}
/**
* Reupload telegram file.
*
* @param mixed $media Telegram file
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $encrypted Whether to encrypt file for secret chats
*/
public function uploadFromTgfile(mixed $media, ?callable $cb = null, bool $encrypted = false)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($media, $cb, $encrypted);
}
/**
* Upload file from URL.
*
* @param string|FileCallbackInterface $url URL of file
* @param integer $size Size of file
* @param string $fileName File name
* @param callable $cb Callback (DEPRECATED, use FileCallbackInterface)
* @param boolean $encrypted Whether to encrypt file for secret chats
*/
public function uploadFromUrl(\danog\MadelineProto\FileCallbackInterface|string $url, int $size = 0, string $fileName = '', ?callable $cb = null, bool $encrypted = false)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($url, $size, $fileName, $cb, $encrypted);
}
/**
* Mark sponsored message as read.
*
* @param int|array $peer Channel ID, or Update, or Message, or Peer.
* @param string|array{random_id: string} $message Random ID or sponsored message to mark as read.
*/
public function viewSponsoredMessage(array|int $peer, array|string $message)
{
return $this->wrapper->getAPI()->{__FUNCTION__}($peer, $message);
}
/**
* Synchronously wait for a Future|generator.
*
* @deprecated Coroutines are deprecated since amp v3
Psalm fixes
2023-01-27 14:42:41 +01:00
* @param \Generator|\Amp\Future $promise The promise to wait for
Refactor public API
2023-01-27 14:20:47 +01:00
*/
public static function wait(\Generator|\Amp\Future $promise)
{
return \danog\MadelineProto\AsyncTools::wait($promise);
}
New API
2023-01-27 14:36:54 +01:00
}
Reference in New Issue Copy Permalink