Message class
Класс построителя сообщений, упрощающий создание сложных сообщений с вложениями.
Конструкторы
| Message(Session) | Создает построитель сообщений. |
Методы
| add |
|
| add |
Добавляет сущность в сообщение. |
| address(IAddress) | Адресная информация о маршрутизации сообщения. Сохраните это поле в внешнем хранилище где-то, чтобы позже создать упреждающее сообщение пользователю. |
| attachment |
Указание о том, как клиенты должны макетировать несколько вложений. Значение по умолчанию — list. |
| attachments(Attachment |
Карточки или изображения для отправки пользователю. |
| code(string) | Код, указывающий, почему беседа закончилась. |
| compose(string[][], any[]) | Создает сложный и случайный ответ пользователю. |
| compose |
вместо этого используйте compose(). |
| compose |
Объединяет массив запросов в один локализованный запрос, а затем при необходимости заполняет слоты шаблонов шаблонов переданными аргументами. |
| entities(Object[]) | Структурированные объекты, передаваемые боту или пользователю. |
| input |
Подсказка для клиентов, которые дают им знать, ожидает ли бот дальнейших входных данных или нет. Встроенные запросы автоматически заполняют это значение для исходящих сообщений. |
| local |
Местное время отправки сообщения (задано клиентом или ботом, ex: 2016-09-23T13:07:49.4714686-07:00.) |
| name(string) | Имя операции для вызова или имени события. |
| nspeak(Text |
Условно задайте поле речи сообщения с указанным числом. |
| ntext(Text |
Условно задать текст сообщения с указанным числом. |
| original |
Сообщение в исходном или собственном формате канала для входящих сообщений. |
| random |
Выбирает запрос случайным образом. |
| relates |
Ссылка на другую беседу или сообщение. |
| set |
вместо этого использовать sourceEvent(). |
| set |
вместо этого использовать local(). |
| set |
вместо этого не рекомендуется использовать ntext(). |
| set |
вместо этого |
| source |
Для исходящих сообщений можно использовать для передачи данных о событиях источника, таких как пользовательские вложения. |
| speak(Text |
Задает поле речи сообщения как язык разметки синтеза речи (SSML). Это будет говорить пользователю на поддерживаемых устройствах. |
| suggested |
Необязательные предлагаемые действия для отправки пользователю. Предлагаемые действия будут отображаться только в каналах, поддерживающих предлагаемые действия. |
| summary(Text |
Текст, отображаемый в качестве резервного копирования и как краткое описание содержимого сообщения, например в списке последних бесед. |
| text(Text |
Задает текст сообщения. |
| text |
Формат текстовых полей. |
| text |
Язык сообщения. |
| timestamp(string) | Устанавливается службой соединителей. Вместо этого используйте localTimestamp(). |
| to |
Возвращает json для сообщения. |
| value(any) | Открытое значение. |
Сведения о конструкторе
Message(Session)
Создает построитель сообщений.
new Message(session?: Session)Параметры
- session
- Session
(Необязательно) будет использоваться для заполнения адреса сообщений и локализации любого текста.
Сведения о методе
addAttachment(AttachmentType)
Добавляет вложение в сообщение. Примеры см. в IAttachment.
function addAttachment(attachment: AttachmentType)Параметры
- attachment
- AttachmentType
Добавление вложения.
Возвращаемое значение
addEntity(Object)
Добавляет сущность в сообщение.
function addEntity(obj: Object)Параметры
- obj
-
Object
Возвращаемое значение
address(IAddress)
Адресная информация о маршрутизации сообщения. Сохраните это поле в внешнем хранилище где-то, чтобы позже создать упреждающее сообщение пользователю.
function address(adr: IAddress)Параметры
- adr
- IAddress
Возвращаемое значение
attachmentLayout(string)
Указание о том, как клиенты должны макетировать несколько вложений. Значение по умолчанию — list.
function attachmentLayout(style: string)Параметры
- style
-
string
Возвращаемое значение
attachments(AttachmentType[])
Карточки или изображения для отправки пользователю.
function attachments(list: AttachmentType[])Параметры
- list
Возвращаемое значение
code(string)
Код, указывающий, почему беседа закончилась.
function code(value: string)Параметры
- value
-
string
Возвращаемое значение
compose(string[][], any[])
Создает сложный и случайный ответ пользователю.
function compose(prompts: string[][], args: any[])Параметры
- prompts
-
string[][]
- args
-
any[]
Возвращаемое значение
composePrompt(Session, string[][], any[])
вместо этого используйте compose().
function composePrompt(session: Session, prompts: string[][], args: any[])Параметры
- session
- Session
- prompts
-
string[][]
- args
-
any[]
Возвращаемое значение
composePrompt(Session, string[][], any[])
Объединяет массив запросов в один локализованный запрос, а затем при необходимости заполняет слоты шаблонов шаблонов переданными аргументами.
static function composePrompt(session: Session, prompts: string[][], args?: any[])Параметры
- session
- Session
Объект сеанса, используемый для локализации отдельных частей запроса.
- prompts
-
string[][]
Массив списков запросов. Каждая запись в массиве представляет собой другой массив запросов, которые будут выбраны случайным образом. Объединенный выходной текст будет разделен пробелом.
- args
-
any[]
(Необязательно) массив аргументов, используемых для форматирования выходного текста, когда запрос является шаблоном.
Возвращаемое значение
string
entities(Object[])
Структурированные объекты, передаваемые боту или пользователю.
function entities(list: Object[])Параметры
- list
-
Object[]
Возвращаемое значение
inputHint(string)
Подсказка для клиентов, которые дают им знать, ожидает ли бот дальнейших входных данных или нет. Встроенные запросы автоматически заполняют это значение для исходящих сообщений.
function inputHint(hint: string)Параметры
- hint
-
string
Возвращаемое значение
localTimestamp(string)
Местное время отправки сообщения (задано клиентом или ботом, ex: 2016-09-23T13:07:49.4714686-07:00.)
function localTimestamp(time?: string)Параметры
- time
-
string
(Необязательно) время, выраженное как строка ISO. По умолчанию используется new Date().toISOString().
Возвращаемое значение
name(string)
Имя операции для вызова или имени события.
function name(name: string)Параметры
- name
-
string
Возвращаемое значение
nspeak(TextType, TextType, number)
Условно задайте поле речи сообщения с указанным числом.
function nspeak(ssml: TextType, ssml_plural: TextType, count: number)Параметры
- ssml
- TextType
- ssml_plural
- TextType
- count
-
number
Возвращаемое значение
ntext(TextType, TextType, number)
Условно задать текст сообщения с указанным числом.
function ntext(msg: TextType, msg_plural: TextType, count: number)Параметры
- msg
- TextType
- msg_plural
- TextType
- count
-
number
Возвращаемое значение
originalEvent(any)
Сообщение в исходном или собственном формате канала для входящих сообщений.
function originalEvent(event: any)Параметры
- event
-
any
Возвращаемое значение
randomPrompt(TextType)
Выбирает запрос случайным образом.
static function randomPrompt(prompts: TextType)Параметры
- prompts
- TextType
Массив запросов на выбор. Если запросы введите строку запрос будет просто возвращен неизменен.
Возвращаемое значение
string
relatesTo(IAddress)
Ссылка на другую беседу или сообщение.
function relatesTo(adr: IAddress)Параметры
- adr
- IAddress
Возвращаемое значение
setChannelData(any)
вместо этого использовать sourceEvent().
function setChannelData(data: any)Параметры
- data
-
any
Возвращаемое значение
setLanguage(string)
вместо этого использовать local().
function setLanguage(language: string)Параметры
- language
-
string
Возвращаемое значение
setNText(Session, string, string, number)
вместо этого не рекомендуется использовать ntext().
function setNText(session: Session, msg: string, msg_plural: string, count: number)Параметры
- session
- Session
- msg
-
string
- msg_plural
-
string
- count
-
number
Возвращаемое значение
setText(Session, TextType, any[])
вместо этого
function setText(session: Session, prompt: TextType, args: any[])Параметры
- session
- Session
- prompt
- TextType
- args
-
any[]
Возвращаемое значение
sourceEvent(ISourceEventMap)
Для исходящих сообщений можно использовать для передачи данных о событиях источника, таких как пользовательские вложения.
function sourceEvent(map: ISourceEventMap)Параметры
- map
- ISourceEventMap
Возвращаемое значение
speak(TextType, any[])
Задает поле речи сообщения как язык разметки синтеза речи (SSML). Это будет говорить пользователю на поддерживаемых устройствах.
function speak(ssml: TextType, args: any[])Параметры
- ssml
- TextType
- args
-
any[]
Возвращаемое значение
suggestedActions(ISuggestedActions | IIsSuggestedActions)
Необязательные предлагаемые действия для отправки пользователю. Предлагаемые действия будут отображаться только в каналах, поддерживающих предлагаемые действия.
function suggestedActions(suggestedActions: ISuggestedActions | IIsSuggestedActions)Параметры
- suggestedActions
Возвращаемое значение
summary(TextType, any[])
Текст, отображаемый в качестве резервного копирования и как краткое описание содержимого сообщения, например в списке последних бесед.
function summary(text: TextType, args: any[])Параметры
- text
- TextType
- args
-
any[]
Возвращаемое значение
text(TextType, any[])
Задает текст сообщения.
function text(text: TextType, args: any[])Параметры
- text
- TextType
- args
-
any[]
Возвращаемое значение
textFormat(string)
Формат текстовых полей.
function textFormat(style: string)Параметры
- style
-
string
Возвращаемое значение
textLocale(string)
Язык сообщения.
function textLocale(locale: string)Параметры
- locale
-
string
Возвращаемое значение
timestamp(string)
Устанавливается службой соединителей. Вместо этого используйте localTimestamp().
function timestamp(time?: string)Параметры
- time
-
string