admin

Documentation

Index

• type ErrorMessage
• type EventMessage
• type InstalledPluginDefinition
• type PadCleanupData
• type PadCreateData
• type PadDBSearch
• type PadDefinition
• type PadDeleteData
• type PadLoadData
• type PluginSearchDefinition
• type SeachchPluginDefinition
• type SearchPluginDefinitionQuery
• type SettingsResultMessage
• type ShoutMessage
• type ShoutMessageRequest
• type ShoutMessageResponse
• type Stats
• type SuccessMessage

Types

type ErrorMessage

type ErrorMessage struct {
	Error string `json:"error"`
}

type EventMessage

type EventMessage struct {
	Event string          `json:"event"`
	Data  json.RawMessage `json:"data"`
}

type InstalledPluginDefinition

type InstalledPluginDefinition struct {
	Name      string `json:"name"`
	Version   string `json:"version"`
	Path      string `json:"path"`
	RealPath  string `json:"realPath"`
	Updatable bool   `json:"updatable"`
}

type PadCleanupData

type PadCleanupData = string

type PadCreateData

type PadCreateData struct {
	PadName string `json:"padName"`
}

type PadDBSearch

type PadDBSearch struct {
	LastEdited     int64  `json:"lastEdited"`
	PadName        string `json:"padName"`
	UserCount      int    `json:"userCount"`
	RevisionNumber int    `json:"revisionNumber"`
}

type PadDefinition

type PadDefinition struct {
	Total   int           `json:"total"`
	Results []PadDBSearch `json:"results"`
}

type PadDeleteData

type PadDeleteData = string

type PadLoadData

type PadLoadData struct {
	Offset    int    `json:"offset"`
	Limit     int    `json:"limit"`
	Pattern   string `json:"pattern"`
	SortBy    string `json:"sortBy"`
	Ascending bool   `json:"ascending"`
}

type PluginSearchDefinition

type PluginSearchDefinition struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Downloads   int    `json:"downloads"`
	Official    bool   `json:"official"`
	Time        string `json:"time"`
	Version     string `json:"version"`
}

type SeachchPluginDefinition

type SeachchPluginDefinition struct {
	Query   SearchPluginDefinitionQuery `json:"query"`
	Results []PluginSearchDefinition    `json:"results"`
}

type SearchPluginDefinitionQuery

type SearchPluginDefinitionQuery struct {
	Offset     int    `json:"offset"`
	Limit      int    `json:"limit"`
	SortBy     string `json:"sortBy"`
	SortDir    string `json:"sortDir"`
	SearchTerm string `json:"searchTerm"`
}

type SettingsResultMessage

type SettingsResultMessage struct {
	Results json.RawMessage `json:"results"`
}

type ShoutMessage

type ShoutMessage struct {
	Message   ShoutMessageRequest `json:"message"`
	Timestamp int64               `json:"timestamp"`
}

type ShoutMessageRequest

type ShoutMessageRequest struct {
	Message string `json:"message"`
	Sticky  bool   `json:"sticky"`
}

type ShoutMessageResponse

type ShoutMessageResponse struct {
	Type string `json:"type"`
	Data struct {
		Type    string       `json:"type"`
		Payload ShoutMessage `json:"payload"`
	} `json:"data"`
}

type Stats

type Stats struct {
	TotalUsers int `json:"totalUsers"`
}

type SuccessMessage

type SuccessMessage struct {
	Success string `json:"success"`
}