fuchsia.setui

PROTOCOLS

SetUiService

Defined in fuchsia.setui/service.fidl

The main interface for UIs to change system settings. Currently, the settings are scoped to the device, but will eventually be scoped to the user as is applicable.

Listen

Begins listening to changes to a given settings object. This may cause the SetUiService to connect to any applicable device services until all listeners for a given type are closed. The service will call the listener with the current state immediately on initialization. DEPRECATED: To be removed in favor of Watch

Request

NameType
settingType SettingType
listener SettingListener

Watch

Returns immediately on first call. Subsequent calls will be delayed until there is an updated value available.

Request

NameType
settingType SettingType

Response

NameType
setting SettingsObject

Update

Sets the value of a given settings object. Returns once operation has completed.

Request

NameType
value SettingsObject

Response

NameType
response UpdateResponse

Mutate

Request

NameType
settingType SettingType
mutation Mutation

Response

NameType
response MutationResponse

InteractiveMutate

Request

NameType
settingType SettingType
mutation Mutation
mutation_handles MutationHandles

Response

NameType
response MutationResponse

SettingListener

Defined in fuchsia.setui/service.fidl

DEPRECATED: To be removed in favor of Watch

Notify

Request

NameType
object SettingsObject

STRUCTS

StringMutation

Defined in fuchsia.setui/mutations.fidl

Configuration for string mutations.

NameTypeDescriptionDefault
operation StringOperation No default
value string No default

WirelessMutation

Defined in fuchsia.setui/mutations.fidl

Configuration for wireless mutations.

NameTypeDescriptionDefault
operation WirelessOperation No default
network_id int64 No default
password string No default

TimeZoneMutation

Defined in fuchsia.setui/mutations.fidl

Configuration for time zone mutation.

NameTypeDescriptionDefault
value TimeZoneInfo No default

LocalesMutation

Defined in fuchsia.setui/mutations.fidl

Mutation that replaces the existing list of locales with a new list.

NameTypeDescriptionDefault
locales vector<string>

See IntlSettings.locales for format.

No default

HourCycleMutation

Defined in fuchsia.setui/mutations.fidl

Mutation that changes the HourCycle.

NameTypeDescriptionDefault
hour_cycle HourCycle No default

TemperatureUnitMutation

Defined in fuchsia.setui/mutations.fidl

Mutation that changes the TemperatureUnit.

NameTypeDescriptionDefault
temperature_unit TemperatureUnit No default

AccountMutationHandles

Defined in fuchsia.setui/mutations.fidl

NameTypeDescriptionDefault
view_holder_token handle<eventpair> No default

SettingsObject

Defined in fuchsia.setui/service.fidl

NameTypeDescriptionDefault
setting_type SettingType No default
data SettingData No default

UpdateResponse

Defined in fuchsia.setui/service.fidl

NameTypeDescriptionDefault
return_code ReturnCode No default

MutationResponse

Defined in fuchsia.setui/service.fidl

NameTypeDescriptionDefault
return_code ReturnCode No default

TimeZoneInfo

Defined in fuchsia.setui/types.fidl

NameTypeDescriptionDefault
current TimeZone?

The current time zone. Will be absent if no time zone is currently set. To update the time zone, set this value.

No default
available vector<TimeZone>

An ordered list of the available time zones.

No default

TimeZone

Defined in fuchsia.setui/types.fidl

NameTypeDescriptionDefault
id string

The underlying ID value; shouldn't be displayed to the end user.

No default
name string

The user visible description of the time zone.

No default
region vector<string>

List of sample locations for which the time zone is valid.

No default

WirelessAccessPoint

Defined in fuchsia.setui/types.fidl

NameTypeDescriptionDefault
bssid vector<uint8>

The associated bssid.

No default
frequency int32 No default
rssi int32

The connection strength of the access point. (read-only)

No default
status ConnectionStatus

The current connection state of the access point.

No default

WirelessNetwork

Defined in fuchsia.setui/types.fidl

NameTypeDescriptionDefault
internal_id int64

The underlying ID value; shouldn't be displayed to the end user. (internal / read-only)

No default
ssid string

The published identifier for the access point. (read-only)

No default
wpa_auth WpaAuth

The auth configuration for the access point.

No default
wpa_cipher WpaCipher

The cipher configuration for the access point.

No default
access_points vector<WirelessAccessPoint> No default

WirelessState

Defined in fuchsia.setui/types.fidl

NameTypeDescriptionDefault
wireless_networks vector<WirelessNetwork>

The available access points to connect to.

No default

ConnectedState

Defined in fuchsia.setui/types.fidl

NameTypeDescriptionDefault
reachability Reachability

The current level of connection access.

No default

IntlSettings

Defined in fuchsia.setui/types.fidl

Collection of internationalization-related settings stored in Stash.

NameTypeDescriptionDefault
locales vector<string>[10]

An ordered list of the user's preferred locales, encoded as Unicode BCP-47 locale identifiers without extensions. Supports language-Script-REGION-variant.

Examples: "fr", "en-US", "sr-Latn-BA", "sl-nedis"

No default
hour_cycle HourCycle

The user's preferred hour cycle, 12 hours or 24 hours.

No default
temperature_unit TemperatureUnit

The user's preferred temperature unit.

No default

ENUMS

StringOperation

Type: uint32

Defined in fuchsia.setui/mutations.fidl

operations supported by string settings.

NameValueDescription
UPDATE 1

AccountOperation

Type: uint32

Defined in fuchsia.setui/mutations.fidl

Operations supported by account settings.

NameValueDescription
ADD 1
SET_LOGIN_OVERRIDE 2

WirelessOperation

Type: uint32

Defined in fuchsia.setui/mutations.fidl

Operations supported by wireless settings.

NameValueDescription
CONNECT 1
DISCONNECT 2

ReturnCode

Type: uint32

Defined in fuchsia.setui/service.fidl

NameValueDescription
OK 0
FAILED 1
UNSUPPORTED 2

SettingType

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
UNKNOWN 0
TIME_ZONE 1
CONNECTIVITY 2
WIRELESS 3
INTL 4
ACCOUNT 5

LoginOverride

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
NONE 0
AUTOLOGIN_GUEST 1

Do not require an account and login always as guest.

AUTH_PROVIDER 2

Requires a provisioned account through auth provider.

ConnectionStatus

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
UNKNOWN 0
DISCONNECTED 1

The connection is at a resting disconnected state.

CONNECTING 2

The connection is being established.

CONNECTED 3

The connection is active.

DISCONNECTING 4

The connection is in the process of being disconnected.

WirelessSecurity

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
UNKNOWN 0
UNSECURED 1

The network is open and requires no password.

SECURED 2

The network is protected by a password.

WpaAuth

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
UNKNOWN 0
NONE_OPEN 1
NONE_WEP 2
NONE_WEP_SHARED 3
IEEE8021X 4
WPA_PSK 5
WPA_EAP 6
WPA2_PSK 7
WPA2_EAP 8

WpaCipher

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
UNKNOWN 0
NONE 1
WEP 2
TKIP 3
CCMP 4

Reachability

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
UNKNOWN 0
WAN 1

we have access to the wide area network.

HourCycle

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
H12 0

12-hour clock

H23 1

24-hour clock (from 0:00:00 to 23:59:59)

TemperatureUnit

Type: uint32

Defined in fuchsia.setui/types.fidl

NameValueDescription
CELSIUS 0
FAHRENHEIT 1

TABLES

AccountMutation

Defined in fuchsia.setui/mutations.fidl

Configuration for account mutations.

OrdinalNameTypeDescription
1 operation AccountOperation
2 login_override LoginOverride

AccountSettings

Defined in fuchsia.setui/types.fidl

OrdinalNameTypeDescription
1 mode LoginOverride

If set, indicates a login behavior specified at runtime.

UNIONS

Mutation

Defined in fuchsia.setui/mutations.fidl

Container for setting mutations.

NameTypeDescription
account_mutation_value AccountMutation
string_mutation_value StringMutation
wireless_mutation_value WirelessMutation
time_zone_mutation_value TimeZoneMutation
locales_mutation_value LocalesMutation
hour_cycle_mutation_value HourCycleMutation
temperature_unit_mutation_value TemperatureUnitMutation

MutationHandles

Defined in fuchsia.setui/mutations.fidl

NameTypeDescription
account_handles AccountMutationHandles

SettingData

Defined in fuchsia.setui/types.fidl

NameTypeDescription
string_value string
time_zone_value TimeZoneInfo

The data returned by the time zone service for getting or setting time zones.

connectivity ConnectedState

The current connected state. (read-only)

wireless WirelessState

The wireless state (read-only).

intl IntlSettings

Internationalization settings.

account AccountSettings