website

type Config ¶

type Config struct {
	Apps       *apps.Apps
	Retries    int
	Timeout    cnfg.Duration
	HostID     string
	BindAddr   string
	NoCompress bool
}

Config is the input data needed to send payloads to notifiarr.

func GetConfig() *Config

type EventType ¶

type EventType string

EventType identifies the type of event that sent a paylaod to notifiarr.

const (
	EventCron    EventType = "cron"
	EventGUI     EventType = "gui"
	EventUser    EventType = "user"
	EventAPI     EventType = "api"
	EventHook    EventType = "webhook"
	EventStart   EventType = "start"
	EventMovie   EventType = "movie"
	EventEpisode EventType = "episode"
	EventPoll    EventType = "poll"
	EventCheck   EventType = "upcheck"
	EventSignal  EventType = "signal"
	EventFile    EventType = "file"
	EventSet     EventType = "setStates"
	EventGet     EventType = "getStates"
)

type Payload ¶

type Payload struct {
	Plex *plex.Sessions        `json:"plex,omitempty"`
	Snap *snapshot.Snapshot    `json:"snapshot,omitempty"`
	Load *plex.IncomingWebhook `json:"payload,omitempty"`
}

Payload is the outbound payload structure that is sent to Notifiarr for Plex and system snapshot data.

type Request ¶

type Request struct {
	ReqID      string
	Route      Route
	Event      EventType
	Params     []string    // optional.
	Payload    any         // data to send.
	UploadFile *UploadFile // file to send (instead of payload).
	LogMsg     string      // if empty, nothing is logged.
	LogPayload bool        // debug log the sent payload.
	ErrorsOnly bool        // only log errors.
	// contains filtered or unexported fields
}

Request is used when sending data through a channel.

type Response ¶

type Response struct {
	Result  string `json:"result"`
	Details struct {
		Response json.RawMessage `json:"response"` // can be anything. type it out later.
		Help     string          `json:"help"`
		Started  time.Time       `json:"started"`
		Finished time.Time       `json:"finished"`
		Elapsed  cnfg.Duration   `json:"elapsed"`
	} `json:"details"`
	// contains filtered or unexported fields
}

Response is what notifiarr replies to our requests with.

try this

{
    "response": "success",
    "message": {
        "response": {
            "instance": 1,
            "debug": null
        },
        "started": "23:57:03",
        "finished": "23:57:03",
        "elapsed": "0s"
    }
}

{
    "response": "success",
    "message": {
        "response": "Service status cron processed.",
        "started": "00:04:15",
        "finished": "00:04:15",
        "elapsed": "0s"
    }
}

{
    "response": "success",
    "message": {
        "response": "Channel stats cron processed.",
        "started": "00:04:31",
        "finished": "00:04:36",
        "elapsed": "5s"
    }
}

{
    "response": "success",
    "message": {
        "response": "Dashboard payload processed.",
        "started": "00:02:04",
        "finished": "00:02:11",
        "elapsed": "7s"
    }
}

nitsua: all responses should be that way.. but response might not always be an object.

func GetData(req *Request) (*Response, error)

func RawGetData(ctx context.Context, req *Request) (*Response, time.Duration, error)

func (r *Response) String() string

type Route ¶

type Route string

Route is used to give us methods on our route paths.

const (
	BaseURL = "https://notifiarr.com"

	CFSyncRoute   Route = userRoute1 + "/trash"
	GapsRoute     Route = userRoute1 + "/gaps"
	MdbListRoute  Route = userRoute1 + "/mdblist"
	TunnelRoute   Route = userRoute1 + "/tunnel"
	ValidateRoute Route = userRoute1 + "/validate"

	ClientRoute Route = userRoute2 + "/client"

	DashRoute     Route = notifiRoute + "/dashboard"
	StuckRoute    Route = notifiRoute + "/stuck"
	DownloadRoute Route = notifiRoute + "/downloads"
	PlexRoute     Route = notifiRoute + "/plex"
	SnapRoute     Route = notifiRoute + "/snapshot"
	SvcRoute      Route = notifiRoute + "/services"
	CorruptRoute  Route = notifiRoute + "/corruption"
	BackupRoute   Route = notifiRoute + "/backup"
	TestRoute     Route = notifiRoute + "/test"
	EndpointRoute Route = notifiRoute + "/endpoint"
	PkgRoute      Route = notifiRoute + "/packageManager"
	LogLineRoute  Route = notifiRoute + "/logWatcher"
	CommandRoute  Route = notifiRoute + "/command"

	UploadRoute Route = systemRoute + "/upload"
)

api (was plexcron)
user (was plexcron)
cron (was plexcron)
webhook (was plexhook)
movie
episode

api
user
cron
start (only fires on startup)

api
user
cron

api
user
cron

api
user
cron

api
user
cron

see description https://github.com/Notifiarr/notifiarr/pull/115

radarr
sonarr

func (r Route) Path(event EventType, params ...string) string

type UploadFile ¶ added in v0.7.0

type UploadFile struct {
	FileName string
	io.ReadCloser
}

UploadFile is the file upload identifier in a request.