Class ConversationClient

Conversation client.

Hierarchy

ChatBotKitClient
- ConversationClient

Index

Constructors

constructor

new ConversationClient(options): ConversationClient
Parameters
- options: ChatBotKitClientOptions
Returns ConversationClient
Overrides ChatBotKitClient.constructor
- Defined in conversation/index.js:32

Properties

attachment

attachment: ConversationAttachmentClient

message

message: ConversationMessageClient

session

session: ConversationSessionClient

Methods

clientFetch

clientFetch<T, U>(path, options?): ResponsePromise<T, U>
Type Parameters
- T
- U
Parameters
- path: string
- Optional options: {
      buffer?: ArrayBuffer;
      external?: boolean;
      file?: {
          data: string | ArrayBuffer;
          name?: string;
          type?: string;
      };
      headers?: Record<string, any>;
      method?: string;
      query?: Record<string, any>;
      record?: Record<string, any>;
  }
  - Optional buffer?: ArrayBuffer
  - Optional external?: boolean
  - Optional file?: {
        data: string | ArrayBuffer;
        name?: string;
        type?: string;
    }
    - data: string | ArrayBuffer
    - Optional name?: string
    - Optional type?: string
  - Optional headers?: Record<string, any>
  - Optional method?: string
  - Optional query?: Record<string, any>
  - Optional record?: Record<string, any>
Returns ResponsePromise<T, U>
Inherited from ChatBotKitClient.clientFetch
- Defined in client.js:219

complete

complete(conversationId, request): ResponsePromise<ConversationCompleteResponse, ConversationCompleteStreamType>
Parameters
- conversationId: null
- request: ConversationCompleteRequest
Returns ResponsePromise<ConversationCompleteResponse, ConversationCompleteStreamType>
- Defined in conversation/index.js:103
complete(conversationId, request): ResponsePromise<ConversationCompleteMessageResponse, ConversationCompleteMessageStreamType>
Parameters
- conversationId: string
- request: ConversationCompleteMessageRequest
Returns ResponsePromise<ConversationCompleteMessageResponse, ConversationCompleteMessageStreamType>
- Defined in conversation/index.js:110

create

create(request): Promise<ConversationCreateResponse>
Creates a new conversation.
Parameters
- request: ConversationCreateRequest
Returns Promise<ConversationCreateResponse>
- Defined in conversation/index.js:77

delete

delete(conversationId): Promise<ConversationDeleteResponse>
Deletes the conversation.
Parameters
- conversationId: string
Returns Promise<ConversationDeleteResponse>
- Defined in conversation/index.js:98

downvote

downvote(conversationId, request): Promise<ConversationDownvoteResponse>
Parameters
- conversationId: string
- request: ConversationDownvoteRequest
Returns Promise<ConversationDownvoteResponse>
- Defined in conversation/index.js:175

fetch

fetch(conversationId): Promise<ConversationFetchResponse>
Fetches a conversation.
Parameters
- conversationId: string
Returns Promise<ConversationFetchResponse>
- Defined in conversation/index.js:67

list

list(request?): ResponsePromise<ConversationListResponse, ConversationListStreamItem>
Retrieves a list of all conversations.
Parameters
- Optional request: ConversationListRequest
Returns ResponsePromise<ConversationListResponse, ConversationListStreamItem>
- Defined in conversation/index.js:57

receive

receive(conversationId, request): ResponsePromise<ConversationReceiveMessageResponse, ConversationReceiveMessageStreamType>
Receives a message from the conversation.
Parameters
- conversationId: string
- request: ConversationReceiveMessageRequest
Returns ResponsePromise<ConversationReceiveMessageResponse, ConversationReceiveMessageStreamType>
- Defined in conversation/index.js:157

send

send(conversationId, request): ResponsePromise<ConversationSendMessageResponse, ConversationSendMessageStreamResult>
Sends a message to the conversation.
Parameters
- conversationId: string
- request: ConversationSendMessageRequest
Returns ResponsePromise<ConversationSendMessageResponse, ConversationSendMessageStreamResult>
- Defined in conversation/index.js:146

update

update(conversationId, request): Promise<ConversationUpdateResponse>
Updates a conversation.
Parameters
- conversationId: string
- request: ConversationUpdateRequest
Returns Promise<ConversationUpdateResponse>
- Defined in conversation/index.js:88

upvote

upvote(conversationId, request): Promise<ConversationUpvoteResponse>
Parameters
- conversationId: string
- request: ConversationUpvoteRequest
Returns Promise<ConversationUpvoteResponse>
- Defined in conversation/index.js:166

Class ConversationClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: ChatBotKitClientOptions

Returns ConversationClient

Properties

attachment

message

session

Methods

clientFetch

Type Parameters

T

U

Parameters

path: string

Optional options: { buffer?: ArrayBuffer; external?: boolean; file?: { data: string | ArrayBuffer; name?: string; type?: string; }; headers?: Record<string, any>; method?: string; query?: Record<string, any>; record?: Record<string, any>; }

Optional buffer?: ArrayBuffer

Optional external?: boolean

Optional file?: { data: string | ArrayBuffer; name?: string; type?: string; }

data: string | ArrayBuffer

Optional name?: string

Optional type?: string

Optional headers?: Record<string, any>

Optional method?: string

Optional query?: Record<string, any>

Optional record?: Record<string, any>

Returns ResponsePromise<T, U>

complete

Parameters

conversationId: null

request: ConversationCompleteRequest

Returns ResponsePromise<ConversationCompleteResponse, ConversationCompleteStreamType>

Parameters

conversationId: string

request: ConversationCompleteMessageRequest

Returns ResponsePromise<ConversationCompleteMessageResponse, ConversationCompleteMessageStreamType>

create

Parameters

request: ConversationCreateRequest

Returns Promise<ConversationCreateResponse>

delete

Parameters

conversationId: string

Returns Promise<ConversationDeleteResponse>

downvote

Parameters

conversationId: string

request: ConversationDownvoteRequest

Returns Promise<ConversationDownvoteResponse>

fetch

Parameters

conversationId: string

Returns Promise<ConversationFetchResponse>

list

Parameters

Optional request: ConversationListRequest

Returns ResponsePromise<ConversationListResponse, ConversationListStreamItem>

receive

Parameters

conversationId: string

request: ConversationReceiveMessageRequest

Returns ResponsePromise<ConversationReceiveMessageResponse, ConversationReceiveMessageStreamType>

send

Parameters

conversationId: string

request: ConversationSendMessageRequest

Returns ResponsePromise<ConversationSendMessageResponse, ConversationSendMessageStreamResult>

update

Parameters

conversationId: string

request: ConversationUpdateRequest

Returns Promise<ConversationUpdateResponse>

upvote

`Optional` options: {
buffer?: ArrayBuffer;
external?: boolean;
file?: {
data: string | ArrayBuffer;
name?: string;
type?: string;
};
headers?: Record<string, any>;
method?: string;
query?: Record<string, any>;
record?: Record<string, any>;
}

`Optional` buffer?: ArrayBuffer

`Optional` external?: boolean

`Optional` file?: {
data: string | ArrayBuffer;
name?: string;
type?: string;
}

`Optional` name?: string

`Optional` type?: string

`Optional` headers?: Record<string, any>

`Optional` method?: string

`Optional` query?: Record<string, any>

`Optional` record?: Record<string, any>

`Optional` request: ConversationListRequest