FirstSignInSettings FirstSignInSettings FirstSignInSettings FirstSignInSettings Class

Definition

Represents a collection of settings that a user can opt-in to during the first run experience.

public : sealed class FirstSignInSettings : IIterable, IMapView, IFirstSignInSettingspublic sealed class FirstSignInSettings : IEnumerable, IReadOnlyDictionary, IFirstSignInSettingsPublic NotInheritable Class FirstSignInSettings Implements IEnumerable, IReadOnlyDictionary, IFirstSignInSettings// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
firstSignInSettings

Properties

Item[TKey] Item[TKey] Item[TKey] Item[TKey]

Gets the element that has the specified key in the read-only dictionary.

This member is not implemented in C++TValue this[TKey key] { get; }ReadOnly Property Item(key As TKey) As TValueTValue this[TKey key] { get; }
Parameters
key
TKey TKey TKey TKey

The key to locate.

Value
TValue TValue TValue TValue

The element that has the specified key in the read-only dictionary.

Exceptions

key is null.

The property is retrieved and key is not found.

Keys Keys Keys Keys

Gets an enumerable collection that contains the keys in the read-only dictionary.

This member is not implemented in C++IEnumerable<TKey> Keys { get; }ReadOnly Property Keys As IEnumerable(Of TKey)IEnumerable<TKey> Keys { get; }
Value

An enumerable collection that contains the keys in the read-only dictionary.

Size Size Size Size

Returns the number of elements in the map.

public : unsigned int Size { get; }This member is not implemented in C#This member is not implemented in VB.Net// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The number of elements in the map.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
firstSignInSettings

Values Values Values Values

Gets an enumerable collection that contains the values in the read-only dictionary.

This member is not implemented in C++IEnumerable<TValue> Values { get; }ReadOnly Property Values As IEnumerable(Of TValue)IEnumerable<TValue> Values { get; }
Value

An enumerable collection that contains the values in the read-only dictionary.

Methods

ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey) ContainsKey(TKey)

Determines whether the read-only dictionary contains an element that has the specified key.

This member is not implemented in C++bool ContainsKey(TKey key)Function ContainsKey(key As TKey) As Booleanbool ContainsKey(TKey key)
Parameters
key
TKey TKey TKey TKey

The key to locate.

Returns

true if the read-only dictionary contains an element that has the specified key; otherwise, false.

Exceptions

key is null.

First() First() First() First()

Returns an iterator for the items in the collection.

public : IIterator<IKeyValuePair<PlatForm::String, PlatForm::Object>> First()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Returns
IIterator<IKeyValuePair<PlatForm::String, PlatForm::Object>> IIterator<KeyValuePair<string, object>> IIterator<KeyValuePair<string, object>> IIterator<KeyValuePair<string, object>>

The iterator.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
firstSignInSettings

GetDefault() GetDefault() GetDefault() GetDefault()

Gets the default instance of the settings.

public : static FirstSignInSettings GetDefault()public static FirstSignInSettings GetDefault()Public Static Function GetDefault() As FirstSignInSettings// You can use this method in JavaScript.
Returns
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
firstSignInSettings

GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the collection.

This member is not implemented in C++IEnumerator<T> GetEnumerator()Function GetEnumerator As IEnumerator(Of T)IEnumerator<T> GetEnumerator()
Returns

An enumerator that can be used to iterate through the collection.

HasKey(String) HasKey(String) HasKey(String) HasKey(String)

Determines whether the map view contains the specified key.

public : PlatForm::Boolean HasKey(PlatForm::String key)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
key
PlatForm::String String String String

The key to locate in the map view.

Returns
PlatForm::Boolean bool bool bool

true if the key is found; otherwise, false.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
firstSignInSettings

Lookup(String) Lookup(String) Lookup(String) Lookup(String)

Returns the item in the map view with the specified key.

public : PlatForm::Object Lookup(PlatForm::String key)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
key
PlatForm::String String String String

The key to locate in the map view.

Returns
PlatForm::Object object object object

The value, if an item with the specified key exists. Use the HasKey method to determine whether the key exists.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
firstSignInSettings

Split(IMapView, IMapView) Split(IMapView, IMapView) Split(IMapView, IMapView) Split(IMapView, IMapView)

Splits the map view into two views.

public : void Split(IMapView<PlatForm::String, PlatForm::Object> first, IMapView<PlatForm::String, PlatForm::Object> second)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
first
IMapView<PlatForm::String, PlatForm::Object> IReadOnlyDictionary<String, Object> IReadOnlyDictionary<String, Object> IReadOnlyDictionary<String, Object>

The first part of the original map.

second
IMapView<PlatForm::String, PlatForm::Object> IReadOnlyDictionary<String, Object> IReadOnlyDictionary<String, Object> IReadOnlyDictionary<String, Object>

The second part of the original map.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
firstSignInSettings

TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue) TryGetValue(TKey, out TValue)

Gets the value that is associated with the specified key.

This member is not implemented in C++bool TryGetValue(TKey key, out TValue value)Function TryGetValue(key As TKey, ByRef value As TValue) As Booleanbool TryGetValue(TKey key, out TValue value)
Parameters
key
TKey TKey TKey TKey

The key to locate.

value
TValue TValue TValue TValue

When this method returns, the value associated with the specified key, if the key is found; otherwise, the default value for the type of the value parameter. This parameter is passed uninitialized.

Returns

true if the object that implements the System.Collections.Generic.IReadOnlyDictionary`2 interface contains an element that has the specified key; otherwise, false.

Exceptions

key is null.