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:1033
The method assigns a bot to a session.

Parameters
- Optional silent: undefined | false | true
Returns Promise<void>

assignToOperator

assignToOperator(operator: UserItemRef): Promise<void>

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

Parameters
- operator: UserItemRef
Returns Promise<void>

assignToOperatorGroup

assignToOperatorGroup(userGroup: UserGroupItemRef): Promise<void>

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

Parameters
- userGroup: UserGroupItemRef
Returns Promise<void>

close

close(): Promise<void>

- Defined in src/dts/09_lines.ts:1045
The method is used to close an active session.

Note that the script should be executed on behalf of the operator or bot assigned to the sessions. Other users cannot close the 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:160
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:1067
The method returns all messages in a session.

Parameters
- Optional from: undefined | number
- Optional size: undefined | number
Returns Promise<LineMessageItem[]>

getLastMessage

getLastMessage(): Promise<LineMessageItem>

- Defined in src/dts/09_lines.ts:1076
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:1088
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>

sendSystemMessage

sendSystemMessage(message: string): Promise<LineMessageItem>

- Defined in src/dts/09_lines.ts:1110
The method sends a system message to a session.

Parameters
- message: string
Returns Promise<LineMessageItem>

setPriority

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

- Defined in src/dts/09_lines.ts:1054
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:1099
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>