Other types and variables

Type Aliases

ClientOptions

ClientOptions: NetworkOptions & KeyStoreOptions & ContentOptions & LegacyOptions

Aggregate type for client options. Optional properties are used when the default value is calculated on invocation, and are computed as needed by each function. All other defaults are specified in defaultOptions.

Defined in

Client.ts:110

---

Composite

Composite: { content: any ; type: ContentTypeId } | { parts: Composite[] }

Defined in

codecs/Composite.ts:24

---

Conversation

Conversation: ConversationV1 | ConversationV2

Defined in

conversations/Conversation.ts:352

---

ListMessagesOptions

ListMessagesOptions: Object

Type declaration

Name	Type
checkAddresses?	boolean
direction?	messageApi.SortDirection
endTime?	Date
limit?	number
startTime?	Date

Defined in

Client.ts:45

---

Message

Message: MessageV1 | MessageV2

Defined in

Message.ts:245

---

PrivateKeyBundle

PrivateKeyBundle: PrivateKeyBundleV1 | PrivateKeyBundleV2

Defined in

crypto/PrivateKeyBundle.ts:232

---

SendOptions

SendOptions: Object

Type declaration

Name	Type
compression?	xmtpEnvelope.Compression
contentFallback?	string
contentType?	ContentTypeId
timestamp?	Date

Defined in

Client.ts:67

Variables

Compression

Compression: typeof Compression

Defined in

Client.ts:29

---

ContentTypeComposite

Const ContentTypeComposite: ContentTypeId

Defined in

codecs/Composite.ts:15

---

ContentTypeFallback

Const ContentTypeFallback: ContentTypeId

Defined in

MessageContent.ts:56

---

ContentTypeText

Const ContentTypeText: ContentTypeId

Defined in

codecs/Text.ts:6

---

SortDirection

SortDirection: typeof SortDirection

Defined in

ApiClient.ts:7

Functions

dateToNs

dateToNs(date): Long

Parameters

Name	Type
date	Date

Returns

Long

Defined in

utils.ts:110

---

fromNanoString

fromNanoString(s): undefined | Date

Parameters

Name	Type
s	undefined | string

Returns

undefined | Date

Defined in

utils.ts:122

---

nsToDate

nsToDate(ns): Date

Parameters

Name	Type
ns	Long

Returns

Date

Defined in

utils.ts:114

---

toNanoString

toNanoString(d): undefined | string

Parameters

Name	Type
d	undefined | Date

Returns

undefined | string

Defined in

utils.ts:118