Class RadixMessageParticle

Particle which can hold arbitrary data

Hierarchy

RadixParticle
- RadixMessageParticle

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RadixMessageParticle(from: RadixAddress, to: RadixAddress, data: any, metaData: object, nonce?: number): RadixMessageParticle

Overrides RadixParticle.constructor
- Defined in modules/atommodel/particles/data/RadixMessageParticle.ts:27
Parameters
- from: RadixAddress
- to: RadixAddress
- data: any
- metaData: object
  - [s: string]: string
- Optional nonce: number
Returns RadixMessageParticle

Properties

bytes

bytes: RadixBytes

from

from: RadixAddress

metaData

metaData: object

Type declaration

[s: string]: string

nonce

nonce: number

to

to: RadixAddress

version

version: number = 100

Static SERIALIZER

SERIALIZER: string = ""

Accessors

destinations

get destinations(): RadixEUID[]
set destinations(destinations: RadixEUID[]): void

Inherited from RadixParticle.destinations
- Defined in modules/atommodel/particles/RadixParticle.ts:29
Returns RadixEUID[]
Inherited from RadixParticle.destinations
- Defined in modules/atommodel/particles/RadixParticle.ts:33
Parameters
- destinations: RadixEUID[]
Returns void

serializer

get serializer(): string
set serializer(_: string): void

Inherited from RadixSerializableObject.serializer
- Defined in modules/atommodel/RadixSerializableObject.ts:33
Returns string
Inherited from RadixSerializableObject.serializer
- Defined in modules/atommodel/RadixSerializableObject.ts:37
Parameters
- _: string
Returns void

Methods

encodeCBOR

encodeCBOR(encoder: any): boolean

Inherited from RadixSerializableObject.encodeCBOR
- Defined in modules/atommodel/RadixSerializableObject.ts:61
Parameters
- encoder: any
Returns boolean

getAddresses

getAddresses(): RadixAddress[]

Overrides RadixParticle.getAddresses
- Defined in modules/atommodel/particles/data/RadixMessageParticle.ts:38
Returns RadixAddress[]

getData

getData(): RadixBytes

- Defined in modules/atommodel/particles/data/RadixMessageParticle.ts:42
Returns RadixBytes

getDestinations

getDestinations(): RadixEUID[]

Inherited from RadixParticle.getDestinations
- Defined in modules/atommodel/particles/RadixParticle.ts:23
Returns RadixEUID[]

getHash

getHash(): Buffer

Inherited from RadixSerializableObject.getHash
- Defined in modules/atommodel/RadixSerializableObject.ts:81
Returns Buffer

getHid

getHid(): RadixEUID

Inherited from RadixParticle.getHid
- Defined in modules/atommodel/particles/RadixParticle.ts:15
Returns RadixEUID

getHidString

getHidString(): string

Inherited from RadixParticle.getHidString
- Defined in modules/atommodel/particles/RadixParticle.ts:19
Returns string

getMetaData

getMetaData(key: string): string

- Defined in modules/atommodel/particles/data/RadixMessageParticle.ts:46
Parameters
- key: string
Returns string

getNonce

getNonce(): number

- Defined in modules/atommodel/particles/data/RadixMessageParticle.ts:56
Returns number

getSize

getSize(): number

Inherited from RadixSerializableObject.getSize
- Defined in modules/atommodel/RadixSerializableObject.ts:85
Returns number

toDSON

toDSON(): Buffer

Inherited from RadixSerializableObject.toDSON
- Defined in modules/atommodel/RadixSerializableObject.ts:57
Returns Buffer

toJSON

toJSON(): object

Inherited from RadixSerializableObject.toJSON
- Defined in modules/atommodel/RadixSerializableObject.ts:41
Returns object
- serializer: string

Static fromJSON

fromJSON(json?: object): any

Inherited from RadixSerializableObject.fromJSON
- Defined in modules/atommodel/RadixSerializableObject.ts:15
Parameters
- Optional json: object
Returns any

Generated using TypeDoc