Class AppInfo

Namespace

VpnHood.AppLib.Api.App

Assembly

VpnHood.AppLib.Api.dll

Represents everything a UI needs to draw itself, in one read: what this build can do, what the app is doing now, what the person chose, and which VPN profiles and languages exist.

public class AppInfo

Inheritance

object

AppInfo

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Configure(ConfigParams, CancellationToken) gives it once the UI has declared its languages, and GetInfo(CancellationToken) reads it again whenever the state says the settings changed (ConfigTime).

Properties

AvailableCultureInfos

Gets the languages the UI offers.

public required IReadOnlyList<UiCultureInfo> AvailableCultureInfos { get; init; }

Property Value

IReadOnlyList<UiCultureInfo>

Descriptor

Gets what the app is and offers on this device.

public required AppDescriptor Descriptor { get; init; }

Property Value

AppDescriptor

IntentFeatures

Gets what the UI may ask of the device.

public required DeviceIntentFeatures IntentFeatures { get; init; }

Property Value

DeviceIntentFeatures

IsRemote

Gets or sets a value indicating whether this client is another device on the local network rather than the app itself; the web host sets it, as only the request knows where it came from.

public bool IsRemote { get; set; }

Property Value

bool

Remarks

The UI draws the TV layout only for the TV itself, and hides the pairing from a phone.

State

Gets the app's state as it stands.

public required AppState State { get; init; }

Property Value

AppState

UserSettings

Gets the person's settings.

public required UserSettings UserSettings { get; init; }

Property Value

UserSettings

VpnProfileInfos

Gets the VPN profiles.

public required IReadOnlyList<VpnProfileInfo> VpnProfileInfos { get; init; }

Property Value

IReadOnlyList<VpnProfileInfo>