Reference: protocol.harmonytypes.v1
Standalone Message Types
HarmonyMethodMetadata
Metadata for methods. These are set in individual RPC endpoints and are typically used by servers.
Fields
requires_authentication
Type: optional bool
whether the method requires authentication.
requires_local
Type: optional bool
whether the method allows federation or not.
requires_permission_node
Type: optional string
the permission nodes required to invoke the method.
requires_owner
Type: optional bool
whether the method requires owner
Anything
Anything holds anything
Fields
kind
Type: optional string
Kind is the kind of the message
body
Type: optional bytes
Body is the serialised bytes
Metadata
Metadata type used by many messages.
Fields
kind
Type: optional string
Kind of this metadata.
extension
Type: repeated protocol.harmonytypes.v1.Metadata.ExtensionEntry
A map containing information.
Metadata.ExtensionEntry
Fields
key
Type: optional string
value
Type: optional protocol.harmonytypes.v1.Anything
Error
Error type that will be returned by servers.
Fields
identifier
Type: optional string
The identifier of this error, can be used as an i18n key.
human_message
Type: optional string
A (usually english) human message for this error.
more_details
Type: optional bytes
More details about this message. Is dependent on the endpoint.
Token
Token that will be used for authentication.
Fields
sig
Type: optional bytes
Ed25519 signature of the following serialized protobuf data, signed with a private key. Which private key used to sign will be described in the documentation.
Has to be 64 bytes long, otherwise it will be rejected.
data
Type: optional bytes
Serialized protobuf data. The protobuf type of this serialized data is dependent on the API endpoint used.
Empty
An empty message
This item has no fields.
ItemPosition
An object representing an item position between two other items.
Fields
item_id
Type: optional uint64
The ID of the item the position is relative to
position
Type: UNHANDLED | TYPE
Whether the position is before or after the given ID