Skip to content

Updating README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thomasstep wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updating README #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
477e4e2
Update README.md
thomasstep Dec 16, 2024
25ca0e5
Update README.md
thomasstep Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,21 @@ npm install @livechat/developer-sdk

## Developer App

The `DeveloperApp` is class that provides methods for initializing and configuring your developer application.
The `App` is class that provides methods for initializing and configuring your developer application.

### Config

In order to use the `DeveloperApp` class in your project first you need to define your `DeveloperAppConfig` accordingly to shape:
In order to use the `App` class in your project first you need to define your `AppConfig` accordingly to shape:

```ts
interface DeveloperAppConfig {
/* 1 */ appId: string;
/* 2 */ auth?: {
clientId?: string;
interface AppConfig {
appId: string;
blocks?: {
authorization?: {
clientId?: string;
}
},
auth?: {
mode?: "popup" | "iframe" | "redirect";
};
}
Expand All @@ -42,14 +46,14 @@ We suggest store config in dedicated file: `livechat.config.json`
but you can also store in it variable:

```ts
const config: DeveloperAppConfig = {
const config: AppConfig = {
// ...
};
```

1. Developer App ID

A required property of `DeveloperAppConfig` is `appId` - it can be obtained directly from Developer Console by extracting it from url:
A required property of `AppConfig` is `appId` - it can be obtained directly from Developer Console by extracting it from url:

```
https://platform.text.com/console/apps/{appId}/monitor
Expand All @@ -61,14 +65,14 @@ If your Developer App has authorization block you can use `Developer-SDK` to pro

### Initialization

Use the `DeveloperApp.init` method to initialize your Developer App. It takes a `DeveloperAppConfig` as its argument and returns a `DeveloperApp` instance:
Use the `App.init` method to initialize your Developer App. It takes an `AppConfig` as its argument and returns an `App` instance:

```ts
import { DeveloperApp, DeveloperAppConfig } from "@livechat/developer-sdk";
import { App, AppConfig } from "@livechat/developer-sdk";
import lcConfig from "./livechat.config.json";

const config = lcConfig as DeveloperAppConfig;
const app = DeveloperApp.init(config);
const config = lcConfig as unknown as AppConfig;
const app = App.init(config);
```

### Authorization
Expand All @@ -92,10 +96,10 @@ In react applications you can build custom hook to ensure proper app initializat

```ts
function useDeveloperApp() {
const [developerApp, setDeveloperApp] = useState<DeveloperApp | null>(null);
const [developerApp, setDeveloperApp] = useState<App | null>(null);

useEffect(() => {
const app = DeveloperApp.init(config);
const app = App.init(config);

if (config.auth?.clientId) {
app.authorize().then(() => setDeveloperApp(app));
Expand Down