Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Artur Fracala committed Oct 28, 2024
1 parent 676271f commit bc6623a
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion packages/agent-app-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,15 @@ Gets the customer profile recorded most recently. Returns the `ICustomerProfile`

### Events

This widget currently does not support any events.
#### `page_data`

Emitted when widget in initialized. The handler will get the main window page data object as an argument:

```ts
interface IPageData {
queryParams: object;
}
```

### Methods

Expand All @@ -255,6 +263,10 @@ Navigates LiveChat Agent App to given pathname.

Updates "Reports" section filters to given `filters` object.

#### `getPageData(): IPageData | null`

Gets the main window page data recorded most recently. Returns the `IPageData` object, which is identical to the one emitted by the `page_data` event or `null` (if no data were registered).

## Settings widget (`ISettingsWidget`)

### Events
Expand Down

0 comments on commit bc6623a

Please sign in to comment.