Class PushSettingsProperties


  • public final class PushSettingsProperties
    extends Object
    PushSettings resource specific properties.
    • Constructor Detail

      • PushSettingsProperties

        public PushSettingsProperties()
    • Method Detail

      • isPushEnabled

        public boolean isPushEnabled()
        Get the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
        Returns:
        the isPushEnabled value.
      • withIsPushEnabled

        public PushSettingsProperties withIsPushEnabled​(boolean isPushEnabled)
        Set the isPushEnabled property: Gets or sets a flag indicating whether the Push endpoint is enabled.
        Parameters:
        isPushEnabled - the isPushEnabled value to set.
        Returns:
        the PushSettingsProperties object itself.
      • tagWhitelistJson

        public String tagWhitelistJson()
        Get the tagWhitelistJson property: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
        Returns:
        the tagWhitelistJson value.
      • withTagWhitelistJson

        public PushSettingsProperties withTagWhitelistJson​(String tagWhitelistJson)
        Set the tagWhitelistJson property: Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.
        Parameters:
        tagWhitelistJson - the tagWhitelistJson value to set.
        Returns:
        the PushSettingsProperties object itself.
      • tagsRequiringAuth

        public String tagsRequiringAuth()
        Get the tagsRequiringAuth property: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.
        Returns:
        the tagsRequiringAuth value.
      • withTagsRequiringAuth

        public PushSettingsProperties withTagsRequiringAuth​(String tagsRequiringAuth)
        Set the tagsRequiringAuth property: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.
        Parameters:
        tagsRequiringAuth - the tagsRequiringAuth value to set.
        Returns:
        the PushSettingsProperties object itself.
      • dynamicTagsJson

        public String dynamicTagsJson()
        Get the dynamicTagsJson property: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
        Returns:
        the dynamicTagsJson value.
      • withDynamicTagsJson

        public PushSettingsProperties withDynamicTagsJson​(String dynamicTagsJson)
        Set the dynamicTagsJson property: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.
        Parameters:
        dynamicTagsJson - the dynamicTagsJson value to set.
        Returns:
        the PushSettingsProperties object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.