Class WindowsKioskConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType

    public class WindowsKioskConfiguration
    extends DeviceConfiguration
    implements com.github.davidmoten.odata.client.ODataEntityType
    “This entity provides descriptions of the declared methods, properties and relationships exposed by the kiosk resource.”
    • Field Detail

      • edgeKioskEnablePublicBrowsing

        protected Boolean edgeKioskEnablePublicBrowsing
      • kioskBrowserBlockedUrlExceptions

        protected List<String> kioskBrowserBlockedUrlExceptions
      • kioskBrowserBlockedUrlExceptionsNextLink

        protected String kioskBrowserBlockedUrlExceptionsNextLink
      • kioskBrowserBlockedURLs

        protected List<String> kioskBrowserBlockedURLs
      • kioskBrowserBlockedURLsNextLink

        protected String kioskBrowserBlockedURLsNextLink
      • kioskBrowserDefaultUrl

        protected String kioskBrowserDefaultUrl
      • kioskBrowserEnableEndSessionButton

        protected Boolean kioskBrowserEnableEndSessionButton
      • kioskBrowserEnableHomeButton

        protected Boolean kioskBrowserEnableHomeButton
      • kioskBrowserEnableNavigationButtons

        protected Boolean kioskBrowserEnableNavigationButtons
      • kioskBrowserRestartOnIdleTimeInMinutes

        protected Integer kioskBrowserRestartOnIdleTimeInMinutes
      • kioskProfilesNextLink

        protected String kioskProfilesNextLink
    • Constructor Detail

      • WindowsKioskConfiguration

        protected WindowsKioskConfiguration()
    • Method Detail

      • odataTypeName

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

        public static WindowsKioskConfiguration.Builder builderWindowsKioskConfiguration()
        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
      • getEdgeKioskEnablePublicBrowsing

        public Optional<Boolean> getEdgeKioskEnablePublicBrowsing()
        “Enable public browsing kiosk mode for the Microsoft Edge browser. The Default is false.”
        Returns:
        property edgeKioskEnablePublicBrowsing
      • withEdgeKioskEnablePublicBrowsing

        public WindowsKioskConfiguration withEdgeKioskEnablePublicBrowsing​(Boolean edgeKioskEnablePublicBrowsing)
        Returns an immutable copy of this with just the edgeKioskEnablePublicBrowsing 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.

        “Enable public browsing kiosk mode for the Microsoft Edge browser. The Default is false.”

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

        public com.github.davidmoten.odata.client.CollectionPage<String> getKioskBrowserBlockedUrlExceptions()
        “Specify URLs that the kiosk browser is allowed to navigate to”
        Returns:
        property kioskBrowserBlockedUrlExceptions
      • withKioskBrowserBlockedUrlExceptions

        public WindowsKioskConfiguration withKioskBrowserBlockedUrlExceptions​(List<String> kioskBrowserBlockedUrlExceptions)
        Returns an immutable copy of this with just the kioskBrowserBlockedUrlExceptions 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.

        “Specify URLs that the kiosk browser is allowed to navigate to”

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

        public com.github.davidmoten.odata.client.CollectionPage<String> getKioskBrowserBlockedUrlExceptions​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Specify URLs that the kiosk browser is allowed to navigate to”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property kioskBrowserBlockedUrlExceptions
      • getKioskBrowserBlockedURLs

        public com.github.davidmoten.odata.client.CollectionPage<String> getKioskBrowserBlockedURLs()
        “Specify URLs that the kiosk browsers should not navigate to”
        Returns:
        property kioskBrowserBlockedURLs
      • withKioskBrowserBlockedURLs

        public WindowsKioskConfiguration withKioskBrowserBlockedURLs​(List<String> kioskBrowserBlockedURLs)
        Returns an immutable copy of this with just the kioskBrowserBlockedURLs 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.

        “Specify URLs that the kiosk browsers should not navigate to”

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

        public com.github.davidmoten.odata.client.CollectionPage<String> getKioskBrowserBlockedURLs​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Specify URLs that the kiosk browsers should not navigate to”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property kioskBrowserBlockedURLs
      • getKioskBrowserDefaultUrl

        public Optional<String> getKioskBrowserDefaultUrl()
        “Specify the default URL the browser should navigate to on launch.”
        Returns:
        property kioskBrowserDefaultUrl
      • withKioskBrowserDefaultUrl

        public WindowsKioskConfiguration withKioskBrowserDefaultUrl​(String kioskBrowserDefaultUrl)
        Returns an immutable copy of this with just the kioskBrowserDefaultUrl 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.

        “Specify the default URL the browser should navigate to on launch.”

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

        public Optional<Boolean> getKioskBrowserEnableEndSessionButton()
        “Enable the kiosk browser's end session button. By default, the end session button is disabled.”
        Returns:
        property kioskBrowserEnableEndSessionButton
      • withKioskBrowserEnableEndSessionButton

        public WindowsKioskConfiguration withKioskBrowserEnableEndSessionButton​(Boolean kioskBrowserEnableEndSessionButton)
        Returns an immutable copy of this with just the kioskBrowserEnableEndSessionButton 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.

        “Enable the kiosk browser's end session button. By default, the end session button is disabled.”

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

        public Optional<Boolean> getKioskBrowserEnableHomeButton()
        “Enable the kiosk browser's home button. By default, the home button is disabled.”
        Returns:
        property kioskBrowserEnableHomeButton
      • withKioskBrowserEnableHomeButton

        public WindowsKioskConfiguration withKioskBrowserEnableHomeButton​(Boolean kioskBrowserEnableHomeButton)
        Returns an immutable copy of this with just the kioskBrowserEnableHomeButton 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.

        “Enable the kiosk browser's home button. By default, the home button is disabled.”

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

        public Optional<Boolean> getKioskBrowserEnableNavigationButtons()
        “Enable the kiosk browser's navigation buttons(forward/back). By default, the navigation buttons are disabled.”
        Returns:
        property kioskBrowserEnableNavigationButtons
      • withKioskBrowserEnableNavigationButtons

        public WindowsKioskConfiguration withKioskBrowserEnableNavigationButtons​(Boolean kioskBrowserEnableNavigationButtons)
        Returns an immutable copy of this with just the kioskBrowserEnableNavigationButtons 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.

        “Enable the kiosk browser's navigation buttons(forward/back). By default, the navigation buttons are disabled.”

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

        public Optional<Integer> getKioskBrowserRestartOnIdleTimeInMinutes()
        “Specify the number of minutes the session is idle until the kiosk browser restarts in a fresh state. Valid values are 1-1440. Valid values 1 to 1440”
        Returns:
        property kioskBrowserRestartOnIdleTimeInMinutes
      • withKioskBrowserRestartOnIdleTimeInMinutes

        public WindowsKioskConfiguration withKioskBrowserRestartOnIdleTimeInMinutes​(Integer kioskBrowserRestartOnIdleTimeInMinutes)
        Returns an immutable copy of this with just the kioskBrowserRestartOnIdleTimeInMinutes 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.

        “Specify the number of minutes the session is idle until the kiosk browser restarts in a fresh state. Valid values are 1-1440. Valid values 1 to 1440”

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

        public com.github.davidmoten.odata.client.CollectionPage<WindowsKioskProfile> getKioskProfiles()
        “This policy setting allows to define a list of Kiosk profiles for a Kiosk configuration. This collection can contain a maximum of 3 elements.”
        Returns:
        property kioskProfiles
      • withKioskProfiles

        public WindowsKioskConfiguration withKioskProfiles​(List<WindowsKioskProfile> kioskProfiles)
        Returns an immutable copy of this with just the kioskProfiles 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 policy setting allows to define a list of Kiosk profiles for a Kiosk configuration. This collection can contain a maximum of 3 elements.”

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

        public com.github.davidmoten.odata.client.CollectionPage<WindowsKioskProfile> getKioskProfiles​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “This policy setting allows to define a list of Kiosk profiles for a Kiosk configuration. This collection can contain a maximum of 3 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property kioskProfiles
      • getWindowsKioskForceUpdateSchedule

        public Optional<WindowsKioskForceUpdateSchedule> getWindowsKioskForceUpdateSchedule()
        “force update schedule for Kiosk devices.”
        Returns:
        property windowsKioskForceUpdateSchedule
      • withWindowsKioskForceUpdateSchedule

        public WindowsKioskConfiguration withWindowsKioskForceUpdateSchedule​(WindowsKioskForceUpdateSchedule windowsKioskForceUpdateSchedule)
        Returns an immutable copy of this with just the windowsKioskForceUpdateSchedule 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.

        “force update schedule for Kiosk devices.”

        Parameters:
        windowsKioskForceUpdateSchedule - new value of windowsKioskForceUpdateSchedule field (as defined in service metadata)
        Returns:
        immutable copy of this with just the windowsKioskForceUpdateSchedule 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 WindowsKioskConfiguration 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 WindowsKioskConfiguration 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