Class ConversationClient

Conversation client.

Hierarchy (view full)

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;
      endpoint?: string;
      external?: boolean;
      fetchFn?: FetchFunction;
      file?: {
          data: string | ArrayBuffer;
          name?: string;
          type?: string;
      };
      headers?: Record<string, any>;
      method?: string;
      query?: Record<string, any>;
      record?: Record<string, any>;
      retries?: number;
      retryDelay?: number;
      retryTimeout?: boolean;
      timeout?: number;
  }
  - Optional buffer?: ArrayBuffer
  - Optional endpoint?: string
  - Optional external?: boolean
  - Optional fetchFn?: FetchFunction
  - 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>
  - Optional retries?: number
  - Optional retryDelay?: number
  - Optional retryTimeout?: boolean
  - Optional timeout?: number
Returns ResponsePromise<T, U>
Inherited from ChatBotKitClient.clientFetch
- Defined in client.js:351

complete

complete(conversationId, request): ResponsePromise<{}, {} | {} | {}>
Parameters
- conversationId: null
- request: ConversationCompleteRequest
Returns ResponsePromise<{}, {} | {} | {}>
- Defined in conversation/index.js:103
complete(conversationId, request): ResponsePromise<{}, {} | {} | {}>
Parameters
- conversationId: string
- request: ConversationCompleteMessageRequest
Returns ResponsePromise<{}, {} | {} | {}>
- Defined in conversation/index.js:110

create

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

delete

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

downvote

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

fetch

fetch(conversationId): ResponsePromise<{} & ({} | {}), never>
Fetches a conversation.
Parameters
- conversationId: string
Returns ResponsePromise<{} & ({} | {}), never>
- Defined in conversation/index.js:67

list

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

receive

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

send

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

update

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

upvote

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

Class ConversationClient

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConversationClient

Properties

attachment

message

session

Methods

clientFetch

Type Parameters

Parameters

Optional buffer?: ArrayBuffer

Optional endpoint?: string

Optional external?: boolean

Optional fetchFn?: FetchFunction

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>

Optional retries?: number

Optional retryDelay?: number

Optional retryTimeout?: boolean

Optional timeout?: number

Returns ResponsePromise<T, U>

complete

Parameters

Returns ResponsePromise<{}, {} | {} | {}>

Parameters

Returns ResponsePromise<{}, {} | {} | {}>

create

Parameters

Returns Promise<{}>

delete

Parameters

Returns Promise<{}>

downvote

Parameters

Returns Promise<{}>

fetch

Parameters

Returns ResponsePromise<{} & ({} | {}), never>

list

Parameters

Returns ResponsePromise<{}, {}>

receive

Parameters

Returns ResponsePromise<{}, {} | {} | {}>

send

Parameters

Returns ResponsePromise<{}, {}>

update

Parameters

Returns Promise<{}>

upvote

Parameters

Returns Promise<{}>

Settings

Member Visibility

Theme

On This Page

`Optional` buffer?: ArrayBuffer

`Optional` endpoint?: string

`Optional` external?: boolean

`Optional` fetchFn?: FetchFunction

`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` retries?: number

`Optional` retryDelay?: number

`Optional` retryTimeout?: boolean

`Optional` timeout?: number