Message

@hyperledger/identus-sdk v8.0.0

---

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

Class: Message

Defined in: packages/shared/domain/build/index.d.ts:300

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

Implements

• Storable

Constructors

Constructor

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

Defined in: packages/shared/domain/build/index.d.ts:316

Parameters

Parameter	Type
body	string | JsonObj<any>
id	string | undefined
piuri	string
from?	DID
to?	DID
attachments?	AttachmentDescriptor[]
thid?	string
extraHeaders?	JsonObj<any>
createdTime?	number
expiresTimePlus?	number
ack?	string[]
direction?	MessageDirection
fromPrior?	string
pthid?	string

Returns

Message

Properties

Property	Modifier	Type	Description	Defined in
ack	readonly	string[]	-	packages/shared/domain/build/index.d.ts:310
attachments	readonly	AttachmentDescriptor[]	-	packages/shared/domain/build/index.d.ts:305
body	readonly	JsonObj	-	packages/shared/domain/build/index.d.ts:315
createdTime	readonly	number	-	packages/shared/domain/build/index.d.ts:308
direction	public	MessageDirection	-	packages/shared/domain/build/index.d.ts:311
expiresTimePlus	readonly	number	-	packages/shared/domain/build/index.d.ts:309
extraHeaders	readonly	JsonObj	-	packages/shared/domain/build/index.d.ts:307
from?	readonly	DID	-	packages/shared/domain/build/index.d.ts:303
fromPrior?	readonly	string	-	packages/shared/domain/build/index.d.ts:312
id	readonly	string	-	packages/shared/domain/build/index.d.ts:301
piuri	readonly	string	-	packages/shared/domain/build/index.d.ts:302
pthid?	readonly	string	-	packages/shared/domain/build/index.d.ts:313
thid?	readonly	string	-	packages/shared/domain/build/index.d.ts:306
to?	readonly	DID	-	packages/shared/domain/build/index.d.ts:304
uuid	public	string	Universally Unique Identifier. should be unique across all items.	packages/shared/domain/build/index.d.ts:314

Methods

fromJson()

static fromJson(jsonString: any): Message

Defined in: packages/shared/domain/build/index.d.ts:317

Parameters

Parameter	Type
jsonString	any

Returns

Message

---

isBase64Attachment()

static isBase64Attachment(data: any): data is AttachmentBase64

Defined in: packages/shared/domain/build/index.d.ts:318

Parameters

Parameter	Type
data	any

Returns

data is AttachmentBase64

---

isJsonAttachment()

static isJsonAttachment(data: any): data is AttachmentJsonData

Defined in: packages/shared/domain/build/index.d.ts:319

Parameters

Parameter	Type
data	any

Returns

data is AttachmentJsonData