surface

Documentation

Index

• type Info
  • func Default() Info
  • func DesktopMacOS(windowID, appVersion, buildChannel string, capabilities map[string]bool) Info
  • func DesktopMacOSWithTopology(topology Topology, windowID, appVersion, buildChannel string, ...) Info
  • func (i Info) CapabilityNames() []string
  • func (i Info) Clone() Info
  • func (i Info) HasCapability(name string) bool
  • func (i Info) Normalize() Info
• type Kind
• type Platform
• type Topology

Types

type Info

type Info struct {
	Kind         Kind            `json:"kind,omitempty"`
	Platform     Platform        `json:"platform,omitempty"`
	Topology     Topology        `json:"topology,omitempty"`
	AppVersion   string          `json:"appVersion,omitempty"`
	BuildChannel string          `json:"buildChannel,omitempty"`
	WindowID     string          `json:"windowID,omitempty"`
	Capabilities map[string]bool `json:"capabilities,omitempty"`
}

Info describes the connected surface.

The zero value normalizes to the default browser/web surface.

func Default

func Default() Info

Default returns the normalized browser/web surface information.

func DesktopMacOS

func DesktopMacOS(windowID, appVersion, buildChannel string, capabilities map[string]bool) Info

DesktopMacOS returns a normalized macOS desktop surface descriptor.

func DesktopMacOSWithTopology

func DesktopMacOSWithTopology(topology Topology, windowID, appVersion, buildChannel string, capabilities map[string]bool) Info

DesktopMacOSWithTopology returns a normalized macOS desktop surface descriptor for the requested runtime topology.

func (Info) CapabilityNames

func (i Info) CapabilityNames() []string

CapabilityNames returns the enabled capability names in deterministic order.

func (Info) Clone

func (i Info) Clone() Info

Clone returns a deep copy of the info value.

func (Info) HasCapability

func (i Info) HasCapability(name string) bool

HasCapability reports whether the named capability is advertised.

func (Info) Normalize

func (i Info) Normalize() Info

Normalize applies default values without mutating the receiver.

type Kind

type Kind string

Kind identifies the broad class of client surface connected to Vango.

const (
	KindWeb     Kind = "web"
	KindDesktop Kind = "desktop"
	KindMobile  Kind = "mobile"
)

type Platform

type Platform string

Platform identifies the concrete platform hosting the Vango surface.

const (
	PlatformBrowser Platform = "browser"
	PlatformMacOS   Platform = "macos"
	PlatformIOS     Platform = "ios"
	PlatformAndroid Platform = "android"
)

type Topology

type Topology string

Topology identifies where the authoritative live Vango session runs.

const (
	TopologyHosted   Topology = "hosted"
	TopologyEmbedded Topology = "embedded"
)