MadelineProtoDocs/docs/PHP/danog/MadelineProto/MTProtoSession/Session.md

205 lines
3.8 KiB
Markdown
Raw Normal View History

2020-10-15 18:42:54 +02:00
---
title: danog\MadelineProto\MTProtoSession\Session: Manages MTProto session-specific data.
description:
---
# `danog\MadelineProto\MTProtoSession\Session`
[Back to index](../../../index.md)
> Author: Daniil Gentili <daniil@daniil.it>
Manages MTProto session-specific data.
---
Generated by [danog/phpdoc](https://phpdoc.daniil.it).
## Method list:
* `resetSession(): void`
* `createSession(): void`
* `backupSession(): array`
* `ackOutgoingMessageId(string|int $message_id): bool`
* `gotResponseForOutgoingMessageId(string|int $message_id): bool`
* `ackIncomingMessageId(string|int $message_id): bool`
* `hasPendingCalls(): bool`
* `getPendingCalls(): array`
* `handleReject(array $request, \Throwable $data): void`
* `handleResponse(): void`
* `methodRecall(string $watcherId, array $args): void`
* `methodCallAsyncRead(string $method, array|\Generator $args, array $aargs): \Generator`
* `methodCallAsyncWrite(string $method, array|\Generator $args, array $aargs): \Generator`
* `objectCall(string $object, array $args, array $aargs): \Generator`
* `sendMsgsStateInfo(string|int $req_msg_id, array $msg_ids): \Generator`
## Methods:
### `resetSession(): void`
Reset MTProto session.
### `createSession(): void`
Create MTProto session if needed.
### `backupSession(): array`
Backup eventual unsent messages before session deletion.
### `ackOutgoingMessageId(string|int $message_id): bool`
Acknowledge outgoing message ID.
Parameters:
* `$message_id`: `string|int` Message Id
### `gotResponseForOutgoingMessageId(string|int $message_id): bool`
We have gotten response for outgoing message ID.
Parameters:
* `$message_id`: `string|int` Message ID
### `ackIncomingMessageId(string|int $message_id): bool`
Acknowledge incoming message ID.
Parameters:
* `$message_id`: `string|int` Message ID
### `hasPendingCalls(): bool`
Check if there are some pending calls.
### `getPendingCalls(): array`
Get all pending calls (also clear pending state requests).
### `handleReject(array $request, \Throwable $data): void`
Reject request with exception.
Parameters:
* `$request`: `array` Request
* `$data`: `\Throwable` Exception
#### See also:
* `\Throwable`
### `handleResponse(): void`
### `methodRecall(string $watcherId, array $args): void`
Recall method.
Parameters:
* `$watcherId`: `string` Watcher ID for defer
* `$args`: `array` Args
### `methodCallAsyncRead(string $method, array|\Generator $args, array $aargs): \Generator`
Call method and wait asynchronously for response.
If the $aargs['noResponse'] is true, will not wait for a response.
Parameters:
* `$method`: `string` Method name
* `$args`: `array|\Generator` Arguments
Full type:
```
array|\Generator<mixed, mixed, mixed, array>
```
* `$aargs`: `array` Additional arguments
#### See also:
* `\Generator`
### `methodCallAsyncWrite(string $method, array|\Generator $args, array $aargs): \Generator`
Call method and make sure it is asynchronously sent (generator).
Parameters:
* `$method`: `string` Method name
* `$args`: `array|\Generator` Arguments
Full type:
```
array|\Generator<mixed, mixed, mixed, array>
```
* `$aargs`: `array` Additional arguments
#### See also:
* `\Generator`
### `objectCall(string $object, array $args, array $aargs): \Generator`
Send object and make sure it is asynchronously sent (generator).
Parameters:
* `$object`: `string` Object name
* `$args`: `array` Arguments
* `$aargs`: `array` Additional arguments
#### See also:
* `\Generator`
### `sendMsgsStateInfo(string|int $req_msg_id, array $msg_ids): \Generator`
Send state info for message IDs.
Parameters:
* `$req_msg_id`: `string|int` Message ID of msgs_state_req that initiated this
* `$msg_ids`: `array` Message IDs to send info about
#### See also:
* `\Generator`