Message

@hyperledger/identus-sdk v7.0.0

---

@hyperledger/identus-sdk / overview / Domain / Message

Class: Message

Defined in: src/domain/models/Message.ts:20

Storable define properties a Domain object must implement to be compatible with Pluto

Implements

• Storable

Constructors

Constructor

new Message(body: string | JsonObj, id: string, piuri: string, from?: DID, to?: DID, attachments?: AttachmentDescriptor[], thid?: string, extraHeaders?: JsonObj, createdTime?: number, expiresTimePlus?: number, ack?: string[], direction?: MessageDirection, fromPrior?: string, pthid?: string): Message

Defined in: src/domain/models/Message.ts:24

Parameters

Parameter	Type	Default value
body	string | JsonObj	undefined
id	string	...
piuri	string	undefined
from?	DID	undefined
to?	DID	undefined
attachments?	AttachmentDescriptor[]	[]
thid?	string	undefined
extraHeaders?	JsonObj	{}
createdTime?	number	...
expiresTimePlus?	number	...
ack?	string[]	[]
direction?	MessageDirection	MessageDirection.RECEIVED
fromPrior?	string	undefined
pthid?	string	undefined

Returns

Message

Properties

Property	Modifier	Type	Default value	Description	Defined in
ack	readonly	string[]	[]	-	src/domain/models/Message.ts:35
attachments	readonly	AttachmentDescriptor[]	[]	-	src/domain/models/Message.ts:30
body	readonly	JsonObj	undefined	-	src/domain/models/Message.ts:22
createdTime	readonly	number	undefined	-	src/domain/models/Message.ts:33
direction	public	MessageDirection	MessageDirection.RECEIVED	-	src/domain/models/Message.ts:36
expiresTimePlus	readonly	number	undefined	-	src/domain/models/Message.ts:34
extraHeaders	readonly	JsonObj	{}	-	src/domain/models/Message.ts:32
from?	readonly	DID	undefined	-	src/domain/models/Message.ts:28
fromPrior?	readonly	string	undefined	-	src/domain/models/Message.ts:37
id	readonly	string	undefined	-	src/domain/models/Message.ts:26
piuri	readonly	string	undefined	-	src/domain/models/Message.ts:27
pthid?	readonly	string	undefined	-	src/domain/models/Message.ts:38
thid?	readonly	string	undefined	-	src/domain/models/Message.ts:31
to?	readonly	DID	undefined	-	src/domain/models/Message.ts:29
uuid	public	string	undefined	Universally Unique Identifier. should be unique across all items.	src/domain/models/Message.ts:21

Methods

fromJson()

static fromJson(jsonString: any): Message

Defined in: src/domain/models/Message.ts:44

Parameters

Parameter	Type
jsonString	any

Returns

Message

---

isBase64Attachment()

static isBase64Attachment(data: any): data is AttachmentBase64

Defined in: src/domain/models/Message.ts:140

Parameters

Parameter	Type
data	any

Returns

data is AttachmentBase64

---

isJsonAttachment()

static isJsonAttachment(data: any): data is AttachmentJsonData

Defined in: src/domain/models/Message.ts:144

Parameters

Parameter	Type
data	any

Returns

data is AttachmentJsonData