1.4.0 • Published 7 months ago
ts-elasticsearch-messaging v1.4.0
ts-elasticsearch-messaging
Setup
- Environment
- ELASTIC_CLOUD_ID
- ELASTIC_CLOUD_USERNAME
- ELASTIC_CLOUD_PASSWORD
Usage
import { OpenMessage, DirectMessage } from "ts-elasticsearch-messaging";Design
Properties
| property | type | memo |
|---|---|---|
| uuid | string | メッセージを一意にする ID |
| kind | string | メッセージの種類 ※内容は後述 |
| parent_uuid | string | Thread 利用の際の親メッセージ ID |
| channel_uuid | string | グループメッセージのように利用する際の ID |
| from_uuid | string | 送信元の個を特定する ID |
| from_name | string | 送信元の名前、表示時に利用しやすいように登録しておく |
| to_uuid | string | 送信先の個を特定する ID、ダイレクトメッセージで利用 |
| comment | string | メッセージ内容 |
| tags | string[] | 上記プロパティで賄えない場合はこのタグを利用（配列内の要素は Key, Value を想定） |
| created_at | string | |
| updated_at | string |
Kind
uuid, kind, from_uuid, from_name, comment, tags, created_at, updated_at は全てに必要なため省略
| kind | need params | null params | memo |
|---|---|---|---|
| DIRECT | to_uuid | parent_uuid, channel_uuid | ダイレクトメッセージの場合に指定 |
| PUBLIC_CHANNEL | channel_uuid | to_uuid, parent_uuid | 公開グループメッセージの場合に指定 |
| PRIVATE_CHANNEL | channel_uuid | to_uuid, parent_uuid | 非公開グループメッセージの場合に指定 |
Thread
uuid, from_uuid, from_name, comment, tags, created_at, updated_at は全てに必要なため省略
| need params | null params | memo |
|---|---|---|
| parent_uuid | kind, channel_uuid, to_uuid | ダイレクトメッセージの場合に指定 |