api

Documentation

Index

• Variables
• type Event
  • func (*Event) Descriptor() ([]byte, []int)
  • func (x *Event) GetExternal() bool
  • func (x *Event) GetName() string
  • func (x *Event) GetProperties() map[string]string
  • func (x *Event) GetTimestamp() *timestamppb.Timestamp
  • func (*Event) ProtoMessage()
  • func (x *Event) ProtoReflect() protoreflect.Message
  • func (x *Event) Reset()
  • func (x *Event) String() string
• type Rpc
  • func (*Rpc) Descriptor() ([]byte, []int)
  • func (x *Rpc) GetHttpKey() string
  • func (x *Rpc) GetId() string
  • func (x *Rpc) GetPayload() string
  • func (*Rpc) ProtoMessage()
  • func (x *Rpc) ProtoReflect() protoreflect.Message
  • func (x *Rpc) Reset()
  • func (x *Rpc) String() string

Variables

var File_api_proto protoreflect.FileDescriptor

Types

type Event

type Event struct {

	// An event name, type, category, or identifier.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Arbitrary event property values.
	Properties map[string]string `` /* 161-byte string literal not displayed */
	// The time when the event was triggered.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// True if the event came directly from a client call, false otherwise.
	External bool `protobuf:"varint,4,opt,name=external,proto3" json:"external,omitempty"`
	// contains filtered or unexported fields
}

Represents an event to be passed through the server to registered event handlers.

func (*Event) Descriptor

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetExternal

func (x *Event) GetExternal() bool

func (*Event) GetName

func (x *Event) GetName() string

func (*Event) GetProperties

func (x *Event) GetProperties() map[string]string

func (*Event) GetTimestamp

func (x *Event) GetTimestamp() *timestamppb.Timestamp

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type Rpc

type Rpc struct {

	// The identifier of the function.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The payload of the function which must be a JSON object.
	Payload string `protobuf:"bytes,2,opt,name=payload,proto3" json:"payload,omitempty"`
	// The authentication key used when executed as a non-client HTTP request.
	HttpKey string `protobuf:"bytes,3,opt,name=http_key,json=httpKey,proto3" json:"http_key,omitempty"`
	// contains filtered or unexported fields
}

Execute an Lua function on the server.

func (*Rpc) Descriptor

func (*Rpc) Descriptor() ([]byte, []int)

Deprecated: Use Rpc.ProtoReflect.Descriptor instead.

func (*Rpc) GetHttpKey

func (x *Rpc) GetHttpKey() string

func (*Rpc) GetId

func (x *Rpc) GetId() string

func (*Rpc) GetPayload

func (x *Rpc) GetPayload() string

func (*Rpc) ProtoMessage

func (*Rpc) ProtoMessage()

func (*Rpc) ProtoReflect

func (x *Rpc) ProtoReflect() protoreflect.Message

func (*Rpc) Reset

func (x *Rpc) Reset()

func (*Rpc) String

func (x *Rpc) String() string