Class BootConfigBuilder

The Boot Config builder exposes a centralized call-site for populating BootConfig options.

Inheritance

Object

BootConfigBuilder

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEditor.XR.OpenXR.Features

Syntax

public class BootConfigBuilder

Methods

SetBootConfigBoolean(String, Boolean)

Method for setting a specific BOOLEAN config option. This method ensures a consistent method for writing a boolean value

Declaration

public bool SetBootConfigBoolean(string key, bool value)

Parameters

Type	Name	Description
String	key	Key of the value to be stored
Boolean	value	Boolean value to set

Returns

Type	Description
Boolean	If the key existing in the boot config and it's "1", return true. Otherwise return false.

SetBootConfigValue(String, String)

Method for setting a specific boot config option, given the key and the string value to store.

Declaration

public bool SetBootConfigValue(string key, string value)

Parameters

Type	Name	Description
String	key	Key of the value to be stored
String	value	String value to write to the key

Returns

Type	Description
Boolean	True if we are able to set the config value, otherwise returns false

TryGetBootConfigBoolean(String, out Boolean)

Return a boolean based on the value stored at key

Declaration

public bool TryGetBootConfigBoolean(string key, out bool value)

Parameters

Type	Name	Description
String	key	key to look for in the boot config
Boolean	value	Where we store the result.

Returns

Type	Description
Boolean	true if we find the key in the bootconfig, otherwise we return false

TryGetBootConfigValue(String, out String)

Get a config value from the boot config, given a specific key.

Declaration

public bool TryGetBootConfigValue(string key, out string value)

Parameters

Type	Name	Description
String	key	Key we want to locate in the boot config
String	value	Where we store the result.

Returns

Type	Description
Boolean	true if we find the key in the bootconfig, otherwise we return false

TryRemoveBootConfigEntry(String)

Try and remove an entry from the boot config.

Declaration

public bool TryRemoveBootConfigEntry(string key)

Parameters

Type	Name	Description
String	key	The key to attempt to remove

Returns

Type	Description
Boolean	true if we were able to remove the boot config entry, otherwise false