toast

type Action ¶

type Action struct {
	Type        string
	Label       string
	Arguments   string
	HintInputId string
}

Action

Defines an actionable button. See https://msdn.microsoft.com/en-us/windows/uwp/controls-and-patterns/tiles-and-notifications-adaptive-interactive-toasts for more info.

Only protocol type action buttons are actually useful, as there's no way of receiving feedback from the user's choice. Examples of protocol type action buttons include: "bingmaps:?q=sushi" to open up Windows 10's maps app with a pre-populated search field set to "sushi".

toast.Action{"protocol", "Open Maps", "bingmaps:?q=sushi"}

type Header ¶

type Header struct {
	Id        string
	Title     string
	Arguments string
}

Header

Defines a header to group notification See https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/toast-headers?tabs=builder-syntax for more info.

toast.Header{"42", "This is a header", "bingmaps:?q=sushi"}

type Input ¶

type Input struct {
	Id           string
	Type         string
	DefaultInput string
	Selections   []Selection
}

type Notification ¶

type Notification struct {
	// The name of your app. This value shows up in Windows 10's Action Centre, so make it
	// something readable for your users. It can contain spaces, however special characters
	// (eg. é) are not supported.
	AppID string

	// The main title/heading for the toast notification.
	Title string

	// The single/multi line message to display for the toast notification.
	Message string

	// Group notifications under headers within ActionCenter
	Header Header

	// An optional path to an image on the OS to display to the top prominently within the toast banner.
	Banner string

	// An optional path to an image on the OS to display at the bottom of the toast
	Image string

	// An optional progress bar to display on the toast
	ProgressBar ProgressBar

	// An optional text to display at the bottom of the notification
	Attribution string

	// An optional path to an image on the OS to display to the left of the title & message.
	Icon string

	// The type of notification level action (like toast.Action)
	ActivationType string

	// The scenario of notification
	Scenario string

	// The activation/action arguments (invoked when the user clicks the notification)
	ActivationArguments string

	// Optional action buttons to display below the notification title & message.
	Actions []Action

	// TODO: Document
	Input Input

	// The audio to play when displaying the toast
	Audio toastAudio

	// Whether to loop the audio (default false)
	Loop bool

	// How long the toast should show up for (short/long)
	Duration toastDuration
}

Notification

The toast notification data. The following fields are strongly recommended;

• AppID
• Title

If no toastAudio is provided, then the toast notification will be silent. You can set the toast to have a default audio by setting "Audio" to "toast.Default", or if your go app takes user-provided input for audio, call the "toast.Audio(name)" func.

The AppID is shown beneath the toast message (in certain cases), and above the notification within the Action Center - and is used to group your notifications together. It is recommended that you provide a "pretty" name for your app, and not something like "com.example.MyApp".

If no Title is provided, but a Message is, the message will display as the toast notification's title - which is a slightly different font style (heavier).

The Icon should be an absolute path to the icon (as the toast is invoked from a temporary path on the user's system, not the working directory).

If you would like the toast to call an external process/open a webpage, then you can set ActivationArguments to the uri you would like to trigger when the toast is clicked. For example: "https://google.com" would open the Google homepage when the user clicks the toast notification. By default, clicking the toast just hides/dismisses it.

The following would show a notification to the user letting them know they received an email, and opens gmail.com when they click the notification. It also makes the Windows 10 "mail" sound effect.

toast := toast.Notification{
    AppID:               "Google Mail",
    Title:               email.Subject,
    Message:             email.Preview,
    Icon:                "C:/Program Files/Google Mail/icons/logo.png",
    ActivationArguments: "https://gmail.com",
    Audio:               toast.Mail,
}

err := toast.Push()

func (n *Notification) Push() error

notification := toast.Notification{
    AppID: "Example App",
    Title: "My notification",
    Message: "Some message about how important something is...",
    Icon: "go.png",
    Actions: []toast.Action{
        {"protocol", "I'm a button", ""},
        {"protocol", "Me too!", ""},
    },
}
err := notification.Push()
if err != nil {
    log.Fatalln(err)
}

type ProgressBar ¶

type ProgressBar struct {
	Title               string
	Value               float32
	Status              string
	ValueStringOverride string
}

ProgressBar

Defines a progress bar. See https://docs.microsoft.com/en-us/windows/uwp/design/shell/tiles-and-notifications/toast-progress-bar for more info.

toast.ProgressBar{"Weekly playlist", 0.6, "Downloading", "15/26 songs"}

type Selection ¶

type Selection struct {
	Id      string
	Content string
}