Builder
class Builder
kotlin.Any | |
↳ | android.app.appsearch.SetBlobVisibilityRequest.Builder |
Builder for SetBlobVisibilityRequest
objects.
Summary
Public constructors | |
---|---|
Builder() |
Public methods | |
---|---|
SetBlobVisibilityRequest.Builder |
addNamespaceVisibleToConfig(namespace: String, visibilityConfig: SchemaVisibilityConfig) Specifies that blobs within the given |
SetBlobVisibilityRequest |
build() Builds a new |
SetBlobVisibilityRequest.Builder |
clearNamespaceVisibleToConfigs(namespace: String) Clears all visibility configurations for the specified blob |
SetBlobVisibilityRequest.Builder |
setNamespaceDisplayedBySystem(namespace: String, displayed: Boolean) Sets whether or not blobs in the specified |
Public constructors
Public methods
addNamespaceVisibleToConfig
fun addNamespaceVisibleToConfig(
namespace: String,
visibilityConfig: SchemaVisibilityConfig
): SetBlobVisibilityRequest.Builder
Specifies that blobs within the given namespace
can be accessed by the caller if they meet the requirements defined in SchemaVisibilityConfig
.
The requirements in each SchemaVisibilityConfig
have an "AND" relationship, meaning that all conditions within a configuration must be met for access. For instance, the caller may need specific permissions and belong to a specific package.
Repeated calls to this method can add multiple SchemaVisibilityConfig
s to a namespace. The caller will have access if they match any of the configurations added, so the configurations form an "OR" relationship.
Parameters | |
---|---|
namespace |
String: The blob namespace to set visibility for. This value cannot be null . |
visibilityConfig |
SchemaVisibilityConfig: The config hold specifying visibility settings. This value cannot be null . |
Return | |
---|---|
SetBlobVisibilityRequest.Builder |
This value cannot be null . |
build
fun build(): SetBlobVisibilityRequest
Builds a new SetBlobVisibilityRequest
object.
Return | |
---|---|
SetBlobVisibilityRequest |
This value cannot be null . |
clearNamespaceVisibleToConfigs
fun clearNamespaceVisibleToConfigs(namespace: String): SetBlobVisibilityRequest.Builder
Clears all visibility configurations for the specified blob namespace
.
After calling this method, the specified namespace will have no visibility configurations, meaning it will only be accessible by default rules.
Parameters | |
---|---|
namespace |
String: The blob namespace for which visibility config should be cleared. This value cannot be null . |
Return | |
---|---|
SetBlobVisibilityRequest.Builder |
This value cannot be null . |
setNamespaceDisplayedBySystem
fun setNamespaceDisplayedBySystem(
namespace: String,
displayed: Boolean
): SetBlobVisibilityRequest.Builder
Sets whether or not blobs in the specified namespace
will be displayed on any system UI surface.
This setting applies to the provided namespace
only, all other namespace
s that are not included here will be reverted to the default displayed setting.
If this method is not called, the default behavior allows blobs to be displayed on system UI surfaces.
Parameters | |
---|---|
namespace |
String: The name of the namespace to configure visibility for. This value cannot be null . |
displayed |
Boolean: If false , blobs in this namespace will not appear on system UI surfaces. |
Return | |
---|---|
SetBlobVisibilityRequest.Builder |
This value cannot be null . |