request

Documentation

Index

• type SubscribeEvents
  • func SubscribeEventsRequest(r *common.Request) (SubscribeEvents, error)
  • func (g *SubscribeEvents) Build(r *common.Request) error
  • func (g *SubscribeEvents) Parse(rawStartBlockID string, rawStartHeight string, rawTypes []string, ...) error

Types

type SubscribeEvents

type SubscribeEvents struct {
	StartBlockID flow.Identifier
	StartHeight  uint64

	EventTypes []string
	Addresses  []string
	Contracts  []string

	HeartbeatInterval uint64
}

func SubscribeEventsRequest

func SubscribeEventsRequest(r *common.Request) (SubscribeEvents, error)

SubscribeEventsRequest extracts necessary variables from the provided request, builds a SubscribeEvents instance, and validates it.

No errors are expected during normal operation.

func (*SubscribeEvents) Build

func (g *SubscribeEvents) Build(r *common.Request) error

func (*SubscribeEvents) Parse

func (g *SubscribeEvents) Parse(
	rawStartBlockID string,
	rawStartHeight string,
	rawTypes []string,
	rawAddresses []string,
	rawContracts []string,
	rawHeartbeatInterval string,
) error