ChatIds Client API

Generated file warning: this page is generated by packages/schema/scripts/gen-client-reference-docs.ts. Do not edit generated method content by hand.

This page documents 1 schema-registry client methods in the chatIds namespace.

`getAllChatIds`

Get all chat IDs

Overview

Prop	Value
Namespace	`chatIds`
Action	`read`
Functionality	`both`
Positional parameter order	-
Aliases	`chatIds.all`, `chatIds.getAll`, `chatIds.list`, `chats.ids`, `listChatIds`
Deprecated aliases	-
License	`none`
WAPI override	-
Deprecated	No

Routes

Type	Method	Path	Name	Status
Primary	`GET`	`/api/chatIds/getAll`	`getAllChatIds`	Active
Alias	`GET`	`/api/chatIds/all`	`chatIds.all`	Active
Alias	`GET`	`/api/chatIds/list`	`chatIds.list`	Active
Alias	`GET`	`/api/chats/ids`	`chats.ids`	Active
Alias	`GET`	`/api/getAllChatIds`	`getAllChatIds`	Active
Alias	`GET`	`/api/listChatIds`	`listChatIds`	Active

Usage

const result = await client.getAllChatIds({});

const result = await client.chatIds.getAll({});

curl -X GET "http://localhost:8080/api/chatIds/getAll" \
  -H "content-type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  --data '{}'

Parameters

This method does not define input parameters.

Output

Prop	Value
Return type	`string[]`

Was this helpful?

Wally and his cute companion coffee mug are coding day and night to keep this up-to-date!