search string side menu

Объект сессии Линий

Type parameters

Hierarchy

Properties

Readonly code

code: string

Код приложения цели ссылки (код приложения).

Readonly data

data: Based<Partial<LineSessionData>>

Значения полей объекта.

Readonly fields

fields: Readonly<object>

Описание полей объекта.

Readonly id

id: string

Идентификатор цели ссылки.

Readonly namespace

namespace: string

Пространство имен цели ссылки (код раздела приложения).

Methods

assignToBot

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

  • Метод назначает сессию на бота.

    Parameters

    • Optional silent: undefined | false | true

      Параметр, позволяющий подавить событие старта бота (по умолчанию false).

      Метод выполняет перевод сессии на бота в случае, если бот подключён к Линии.

      await Context.data.session.assignToBot();

    Returns Promise<void>

assignToOperator

  • assignToOperator(operator: UserItemRef): Promise<void>

  • Метод назначает сессию на оператора.

    Parameters

    • operator: UserItemRef

      Оператор.

      await Context.data.session.assignToOperator(Context.data.user);

    Returns Promise<void>

assignToOperatorGroup

  • Метод назначает сессию на группу операторов.

    Parameters

    • userGroup: UserGroupItemRef

      Группа операторов. Должна быть добавлена в список операторов Линии.

      await Context.data.session.assignToOperatorGroup(Context.data.userGroup);

    Returns Promise<void>

close

  • close(): Promise<void>

  • Метод закрывает активную сессию.

    await Context.data.session.close();

    Returns Promise<void>

fetch

getAllMessages

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

  • Метод получает всю переписку сессии.

    Parameters

    • Optional from: undefined | number

      Количество элементов, которое необходимо пропустить (по умолчанию 0).

    • Optional size: undefined | number

      Размер выборки (по умолчанию 10, максимум 10000).

      // Получим 100 первых сообщений сессии.
const messages = await Context.data.session.getAllMessages(0, 100);

    Returns Promise<LineMessageItem[]>

getLastMessage

  • Метод получает последнее сообщение сессии.

    const lastMessage = await Context.data.session.getLastMessage();

    Returns Promise<LineMessageItem>

markAsSpam

  • markAsSpam(): Promise<void>

  • Метод помечает сессию как спам.

    Статистика (метрики) сессий в спаме не учитываются в отчётах. Метод не поддерживается для каналов типа internal, support (см. LineChannelType).

    await Context.data.session.markAsSpam();

    Returns Promise<void>

normalize

  • normalize(): void

  • Удаление дублирующихся данных в массивах.

    Выполнить удаление дубликатов в полях, в которых хранятся массивы ссылок на объекты системы (пользователи, файлы, элементы приложений, документы).

    Этот метод, например, можно вызвать после массового изменения данных в объекте.

    const app1 = await Context.data.app1.fetch();
const app2 = await Context.data.app2.fetch();

app1.data.executors.push(app2.data.executors);
app1.normalize();

// Далее перебираем элементы нового массива
app1.data.executors.forEach( ... );

    Returns void

save

  • save(): Promise<void>

  • Метод сохраняет объект сессии.

    Метод позволяет обновлять текущую сессию. Поля, доступные для редактирования: __name, _apps.

        const session = await Context.data.session.fetch();
    session.data.__name = "new session name";
    session.data._apps.push(Context.data.lead);

    await session.save();

    Returns Promise<void>

sendSystemMessage

  • Метод отправляет системное сообщение в сессию.

    Parameters

    • message: string

      Сообщение в виде текста или HTML.

      const message = Context.data.session.sendSystemMessage('Приоритет изменён на "Высокий"');

    Returns Promise<LineMessageItem>

setPriority

  • Метод устанавливает приоритет сессии.

    await Context.data.session.setPriority(LineSessionPriority.Low);

    Parameters

    Returns Promise<void>

unmarkAsSpam

  • unmarkAsSpam(): Promise<void>

  • Метод удаляет сессию из спама.

    Сессия возвращается предыдущему оператору в работу либо помещается в очередь.

    await Context.data.session.unmarkAsSpam();

    Returns Promise<void>