Link to the Live Chat session object

Type parameters

I: Item<ItemData>

Hierarchy

ItemRef<LineSessionItem>
- LineSessionItemRef
  - LineSessionItem

Properties

Readonly code

code: string

App code of the URL’s target (the app’s code).

Readonly id

id: string

ID of the URL’s target.

Readonly namespace

namespace: string

Namespace of the URL target (the code of the workspace that the app belongs to).

Methods

assignToBot

assignToBot(silent?: undefined | false | true): Promise<void>

- Defined in src/dts/09_lines.ts:1022
The method assigns a bot to a session.

Parameters
- Optional silent: undefined | false | true
  Parameter that cancels the bot start event (the default value if false).
  The method assigns a session to the bot if there’s a bot connected to the live chat.
```
await Context.data.session.assignToBot();
```
Returns Promise<void>

assignToOperator

assignToOperator(operator: UserItemRef): Promise<void>

- Defined in src/dts/09_lines.ts:998
The method assigns an operator to a session.

Parameters
- operator: UserItemRef
  Operator.
```
await Context.data.session.assignToOperator(Context .data.user);
```
Returns Promise<void>

assignToOperatorGroup

assignToOperatorGroup(userGroup: UserGroupItemRef): Promise<void>

- Defined in src/dts/09_lines.ts:1009
The method assigns a group of operators to a session.

Parameters
- userGroup: UserGroupItemRef
  Operator group. It has to be added to the Live Chat operators list.
```
await Context.data.session.assignToOperatorGroup(Context.data. userGroup);
```
Returns Promise<void>

close

close(): Promise<void>

- Defined in src/dts/09_lines.ts:1031
The method is used to close an active session.
```
await Context.data.session.close();
```
Returns Promise<void>

fetch

fetch(): Promise<LineSessionItem>

Inherited from LineItem.fetch

Overrides RefItem.fetch
- Defined in src/dts/01_items.ts:179
Request complete data of a reference object.

Returns Promise<LineSessionItem>

getAllMessages

getAllMessages(from?: undefined | number, size?: undefined | number): Promise<LineMessageItem[]>

- Defined in src/dts/09_lines.ts:1053
The method returns all messages in a session.

Parameters
- Optional from: undefined | number
  
  Number of entries to skip (the default value is 0).
- Optional size: undefined | number
  Number of search results (the default number is 10, the maximum is 10,000).
```
// Get the first one hundred messages in a session 
const  messages = await Context.data.session.getAllMessages(0, 100); 
```
Returns Promise<LineMessageItem[]>

getLastMessage

getLastMessage(): Promise<LineMessageItem>

- Defined in src/dts/09_lines.ts:1062
The method returns the last message in a session.
```
const lastMessage = await Context.data.session. getLastMessage();
```
Returns Promise<LineMessageItem>

markAsSpam

markAsSpam(): Promise<void>

- Defined in src/dts/09_lines.ts:1074
The method marks a session as spam.

The data (metrics) of a session marked as spam are not taken into account when generating reports. The method is not available for the following types of channels: internal and support (see LineChannelType).
```
await Context.data.session.markAsSpam();
```
Returns Promise<void>

setPriority

setPriority(priority?: LineSessionPriorityEnumBase): Promise<void>

- Defined in src/dts/09_lines.ts:1040
The method is used to set a session’s priority.
```
await Context.data.session.setPriority(LineSessionPriority. Low);
```
Parameters
- Optional priority: LineSessionPriorityEnumBase
Returns Promise<void>

unmarkAsSpam

unmarkAsSpam(): Promise<void>

- Defined in src/dts/09_lines.ts:1085
The method deletes a session from spam.

The session is assigned to the operator who previously worked on it or added to the queue.
```
await Context.data.session.unmarkAsSpam();
```
Returns Promise<void>