Skip to content

Commit

Permalink
Update docs for BotInitiatedUpdate
Browse files Browse the repository at this point in the history
  • Loading branch information
alies-dev committed Nov 24, 2024
1 parent 83e901d commit 2b17202
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This is a major release that includes several backward-incompatible changes. Ple

### Method Renames

#### Dialog Class
#### `Dialog` Class

The following methods have been renamed to improve clarity and consistency:

Expand All @@ -19,7 +19,7 @@ $dialog->ttl() $dialog->getTtl()
$dialog->proceed() $dialog->performStep() // internal method
```

#### DialogManager Class
#### `DialogManager` Class

```php
// Before // After
Expand All @@ -32,6 +32,10 @@ $manager->exists() $manager->hasActiveDialog()
$manager->startNewDialogInitiatedByBot($dialog); $manager->initiateDialog($dialog);
```

### `BotInitiatedUpdate` Class

`Dialog $dialg` parameter has been [removed](83e901d0) from the constructor, as well as the `$dialog` property from the class.

### Removed Methods

The following deprecated methods have been removed:
Expand Down Expand Up @@ -59,7 +63,7 @@ $this->memory->forget('key');

### Internal Methods Renames

The following internal methods in DialogManager have been renamed:
The following internal methods in `DialogManager` have been renamed:

```php
// Before // After
Expand All @@ -70,4 +74,4 @@ readDialogState() retrieveDialog()
forgetDialogState() forgetDialog()
```

Note: These are internal changes and shouldn't affect your application unless you've extended DialogManager.
Note: These are internal changes and shouldn't affect your application unless you've extended `DialogManager`.

0 comments on commit 2b17202

Please sign in to comment.