adamant-api / api / ChatroomsOptions
Interface: ChatroomsOptions
Defined in: src/api/index.ts:292
Options for the chat endpoints: /api/chatrooms (getChats, getChatMessages) and the legacy /api/chats/get (getChatTransactions).
Verified against the node query builders, these endpoints apply only type, senderId, recipientId, the direct-transfer toggle, and pagination — plus userId on /api/chatrooms, and isIn / inId and fromHeight on /api/chats/get. Other inherited fields (most range filters) are accepted by the node but not applied, so they have no effect. Amount filters are excluded at the type level (they belong to TransactionsOptions).
Extends
Properties
blockId?
optional blockId?: string;Defined in: src/api/index.ts:264
Inherited from
TransactionQueryParameters.blockId
fromHeight?
optional fromHeight?: number;Defined in: src/api/index.ts:265
Inherited from
TransactionQueryParameters.fromHeight
fromTimestamp?
optional fromTimestamp?: number;Defined in: src/api/index.ts:267
Inherited from
TransactionQueryParameters.fromTimestamp
includeDirectTransfers?
optional includeDirectTransfers?: boolean | 0 | 1;Defined in: src/api/index.ts:295
inId?
optional inId?: string;Defined in: src/api/index.ts:274
Inherited from
TransactionQueryParameters.inId
isIn?
optional isIn?: string;Defined in: src/api/index.ts:275
Inherited from
TransactionQueryParameters.isIn
limit?
optional limit?: number;Defined in: src/api/index.ts:276
Inherited from
TransactionQueryParameters.limit
maxFee?
optional maxFee?: number;Defined in: src/api/index.ts:270
Inherited from
TransactionQueryParameters.maxFee
minConfirmations?
optional minConfirmations?: number;Defined in: src/api/index.ts:271
Inherited from
TransactionQueryParameters.minConfirmations
minFee?
optional minFee?: number;Defined in: src/api/index.ts:269
Inherited from
TransactionQueryParameters.minFee
offset?
optional offset?: number;Defined in: src/api/index.ts:277
Inherited from
TransactionQueryParameters.offset
orderBy?
optional orderBy?: string;Defined in: src/api/index.ts:278
Inherited from
TransactionQueryParameters.orderBy
recipientId?
optional recipientId?: string;Defined in: src/api/index.ts:273
Inherited from
TransactionQueryParameters.recipientId
returnUnconfirmed?
optional returnUnconfirmed?: 0 | 1;Defined in: src/api/index.ts:263
Inherited from
TransactionQueryParameters.returnUnconfirmed
senderId?
optional senderId?: string;Defined in: src/api/index.ts:272
Inherited from
TransactionQueryParameters.senderId
toHeight?
optional toHeight?: number;Defined in: src/api/index.ts:266
Inherited from
TransactionQueryParameters.toHeight
toTimestamp?
optional toTimestamp?: number;Defined in: src/api/index.ts:268
Inherited from
TransactionQueryParameters.toTimestamp
type?
optional type?: number;Defined in: src/api/index.ts:293
userId?
optional userId?: string;Defined in: src/api/index.ts:294
withoutDirectTransfers?
optional withoutDirectTransfers?: boolean | 0 | 1;Defined in: src/api/index.ts:297
Deprecated
Use includeDirectTransfers instead.