message

Documentation

Index

• Constants
• func Plugin() *node.Plugin
• type FindByIDRequest
• type FindByIDResponse
• type Message
• type Metadata
• type SendPayloadRequest
• type SendPayloadResponse

Constants

const PluginName = "WebAPI message Endpoint"

PluginName is the name of the web API message endpoint plugin.

Functions

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

Types

type FindByIDRequest

type FindByIDRequest struct {
	IDs []string `json:"ids"`
}

FindByIDRequest holds the message ids to query.

type FindByIDResponse

type FindByIDResponse struct {
	Messages []Message `json:"messages,omitempty"`
	Error    string    `json:"error,omitempty"`
}

FindByIDResponse is the HTTP response containing the queried messages.

type Message

type Message struct {
	Metadata        `json:"metadata,omitempty"`
	ID              string   `json:"ID,omitempty"`
	StrongParents   []string `json:"strongParents,omitempty"`
	WeakParents     []string `json:"weakParents,omitempty"`
	IssuerPublicKey string   `json:"issuerPublicKey,omitempty"`
	IssuingTime     int64    `json:"issuingTime,omitempty"`
	SequenceNumber  uint64   `json:"sequenceNumber,omitempty"`
	Payload         []byte   `json:"payload,omitempty"`
	Signature       string   `json:"signature,omitempty"`
}

Message contains information about a given message.

type Metadata

type Metadata struct {
	Solid              bool  `json:"solid,omitempty"`
	SolidificationTime int64 `json:"solidificationTime,omitempty"`
}

Metadata contains metadata information of a message.

type SendPayloadRequest

type SendPayloadRequest struct {
	Payload []byte `json:"payload"`
}

SendPayloadRequest contains the message to send.

type SendPayloadResponse

type SendPayloadResponse struct {
	ID    string `json:"id,omitempty"`
	Error string `json:"error,omitempty"`
}

SendPayloadResponse contains the ID of the message sent.