Package odata.msgraph.client.beta.entity

Class IosWiFiConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    Direct Known Subclasses:
    IosEnterpriseWiFiConfiguration
    public class IosWiFiConfiguration
extends DeviceConfiguration
implements com.github.davidmoten.odata.client.ODataEntityType
    “By providing the configurations in this profile you can instruct the iOS device to connect to desired Wi-Fi endpoint. By specifying the authentication method and security types expected by Wi-Fi endpoint you can make the Wi-Fi connection seamless for end user. This profile provides limited and simpler security types than Enterprise Wi-Fi profile.”

    • Field Detail

      • connectAutomatically

        protected Boolean connectAutomatically

      • connectWhenNetworkNameIsHidden

        protected Boolean connectWhenNetworkNameIsHidden

      • disableMacAddressRandomization

        protected Boolean disableMacAddressRandomization

      • networkName

        protected String networkName

      • preSharedKey

        protected String preSharedKey

      • proxyAutomaticConfigurationUrl

        protected String proxyAutomaticConfigurationUrl

      • proxyManualAddress

        protected String proxyManualAddress

      • proxyManualPort

        protected Integer proxyManualPort

    • Constructor Detail

      • IosWiFiConfiguration

        protected IosWiFiConfiguration()

    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class DeviceConfiguration

      • builderIosWiFiConfiguration

        public static IosWiFiConfiguration.Builder builderIosWiFiConfiguration()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class

      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class DeviceConfiguration

      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class DeviceConfiguration

      • getConnectAutomatically

        public Optional<Boolean> getConnectAutomatically()
        “Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.”
        Returns:
        property connectAutomatically

      • withConnectAutomatically

        public IosWiFiConfiguration withConnectAutomatically​(Boolean connectAutomatically)
        Returns an immutable copy of this with just the connectAutomatically field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Connect automatically when this network is in range. Setting this to true will skip the user prompt and automatically connect the device to Wi-Fi network.”

        Parameters:
        connectAutomatically - new value of connectAutomatically field (as defined in service metadata)
        Returns:
        immutable copy of this with just the connectAutomatically field changed

      • getConnectWhenNetworkNameIsHidden

        public Optional<Boolean> getConnectWhenNetworkNameIsHidden()
        “Connect when the network is not broadcasting its name (SSID). When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.”
        Returns:
        property connectWhenNetworkNameIsHidden

      • withConnectWhenNetworkNameIsHidden

        public IosWiFiConfiguration withConnectWhenNetworkNameIsHidden​(Boolean connectWhenNetworkNameIsHidden)
        Returns an immutable copy of this with just the connectWhenNetworkNameIsHidden field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Connect when the network is not broadcasting its name (SSID). When set to true, this profile forces the device to connect to a network that doesn't broadcast its SSID to all devices.”

        Parameters:
        connectWhenNetworkNameIsHidden - new value of connectWhenNetworkNameIsHidden field (as defined in service metadata)
        Returns:
        immutable copy of this with just the connectWhenNetworkNameIsHidden field changed

      • getDisableMacAddressRandomization

        public Optional<Boolean> getDisableMacAddressRandomization()
        “If set to true, forces devices connecting using this Wi-Fi profile to present their actual Wi-Fi MAC address instead of a random MAC address. Applies to iOS 14 and later.”
        Returns:
        property disableMacAddressRandomization

      • withDisableMacAddressRandomization

        public IosWiFiConfiguration withDisableMacAddressRandomization​(Boolean disableMacAddressRandomization)
        Returns an immutable copy of this with just the disableMacAddressRandomization field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If set to true, forces devices connecting using this Wi-Fi profile to present their actual Wi-Fi MAC address instead of a random MAC address. Applies to iOS 14 and later.”

        Parameters:
        disableMacAddressRandomization - new value of disableMacAddressRandomization field (as defined in service metadata)
        Returns:
        immutable copy of this with just the disableMacAddressRandomization field changed

      • getNetworkName

        public Optional<String> getNetworkName()
        “Network Name”
        Returns:
        property networkName

      • withNetworkName

        public IosWiFiConfiguration withNetworkName​(String networkName)
        Returns an immutable copy of this with just the networkName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Network Name”

        Parameters:
        networkName - new value of networkName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the networkName field changed

      • getPreSharedKey

        public Optional<String> getPreSharedKey()
        “This is the pre-shared key for WPA Personal Wi-Fi network.”
        Returns:
        property preSharedKey

      • withPreSharedKey

        public IosWiFiConfiguration withPreSharedKey​(String preSharedKey)
        Returns an immutable copy of this with just the preSharedKey field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “This is the pre-shared key for WPA Personal Wi-Fi network.”

        Parameters:
        preSharedKey - new value of preSharedKey field (as defined in service metadata)
        Returns:
        immutable copy of this with just the preSharedKey field changed

      • getProxyAutomaticConfigurationUrl

        public Optional<String> getProxyAutomaticConfigurationUrl()
        “URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.”
        Returns:
        property proxyAutomaticConfigurationUrl

      • withProxyAutomaticConfigurationUrl

        public IosWiFiConfiguration withProxyAutomaticConfigurationUrl​(String proxyAutomaticConfigurationUrl)
        Returns an immutable copy of this with just the proxyAutomaticConfigurationUrl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “URL of the proxy server automatic configuration script when automatic configuration is selected. This URL is typically the location of PAC (Proxy Auto Configuration) file.”

        Parameters:
        proxyAutomaticConfigurationUrl - new value of proxyAutomaticConfigurationUrl field (as defined in service metadata)
        Returns:
        immutable copy of this with just the proxyAutomaticConfigurationUrl field changed

      • getProxyManualAddress

        public Optional<String> getProxyManualAddress()
        “IP Address or DNS hostname of the proxy server when manual configuration is selected.”
        Returns:
        property proxyManualAddress

      • withProxyManualAddress

        public IosWiFiConfiguration withProxyManualAddress​(String proxyManualAddress)
        Returns an immutable copy of this with just the proxyManualAddress field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “IP Address or DNS hostname of the proxy server when manual configuration is selected.”

        Parameters:
        proxyManualAddress - new value of proxyManualAddress field (as defined in service metadata)
        Returns:
        immutable copy of this with just the proxyManualAddress field changed

      • getProxyManualPort

        public Optional<Integer> getProxyManualPort()
        “Port of the proxy server when manual configuration is selected.”
        Returns:
        property proxyManualPort

      • withProxyManualPort

        public IosWiFiConfiguration withProxyManualPort​(Integer proxyManualPort)
        Returns an immutable copy of this with just the proxyManualPort field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Port of the proxy server when manual configuration is selected.”

        Parameters:
        proxyManualPort - new value of proxyManualPort field (as defined in service metadata)
        Returns:
        immutable copy of this with just the proxyManualPort field changed

      • getProxySettings

        public Optional<WiFiProxySetting> getProxySettings()
        “Proxy Type for this Wi-Fi connection”
        Returns:
        property proxySettings

      • withProxySettings

        public IosWiFiConfiguration withProxySettings​(WiFiProxySetting proxySettings)
        Returns an immutable copy of this with just the proxySettings field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Proxy Type for this Wi-Fi connection”

        Parameters:
        proxySettings - new value of proxySettings field (as defined in service metadata)
        Returns:
        immutable copy of this with just the proxySettings field changed

      • getSsid

        public Optional<String> getSsid()
        “This is the name of the Wi-Fi network that is broadcast to all devices.”
        Returns:
        property ssid

      • withSsid

        public IosWiFiConfiguration withSsid​(String ssid)
        Returns an immutable copy of this with just the ssid field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “This is the name of the Wi-Fi network that is broadcast to all devices.”

        Parameters:
        ssid - new value of ssid field (as defined in service metadata)
        Returns:
        immutable copy of this with just the ssid field changed

      • getWiFiSecurityType

        public Optional<WiFiSecurityType> getWiFiSecurityType()
        “Indicates whether Wi-Fi endpoint uses an EAP based security type.”
        Returns:
        property wiFiSecurityType

      • withWiFiSecurityType

        public IosWiFiConfiguration withWiFiSecurityType​(WiFiSecurityType wiFiSecurityType)
        Returns an immutable copy of this with just the wiFiSecurityType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Indicates whether Wi-Fi endpoint uses an EAP based security type.”

        Parameters:
        wiFiSecurityType - new value of wiFiSecurityType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the wiFiSecurityType field changed

      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class DeviceConfiguration

      • patch

        public IosWiFiConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class DeviceConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected

      • put

        public IosWiFiConfiguration put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class DeviceConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected