SetBlobVisibilityRequest


public class SetBlobVisibilityRequest
extends Object

java.lang.Object
   ↳ android.app.appsearch.SetBlobVisibilityRequest


Request to configure the visibility settings of blobs in AppSearch.

Used with AppSearchSession.setBlobVisibility to specify visibility and display properties for blob namespaces. You can control which blob namespaces are displayed on system UI surfaces and which are accessible based on specific visibility configurations.

Summary

Nested classes

class SetBlobVisibilityRequest.Builder

Builder for SetBlobVisibilityRequest objects. 

Public methods

Set<String> getNamespacesNotDisplayedBySystem()

Returns all the blob namespaces that are opted out of being displayed and visible on any system UI surface.

Map<StringSet<SchemaVisibilityConfig>> getNamespacesVisibleToConfigs()

Returns a mapping of blob namespaces to the set of SchemaVisibilityConfigs that have access to that namespace.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

getNamespacesNotDisplayedBySystem

public Set<String> getNamespacesNotDisplayedBySystem ()

Returns all the blob namespaces that are opted out of being displayed and visible on any system UI surface.

Returns
Set<String> This value cannot be null.

getNamespacesVisibleToConfigs

public Map<StringSet<SchemaVisibilityConfig>> getNamespacesVisibleToConfigs ()

Returns a mapping of blob namespaces to the set of SchemaVisibilityConfigs that have access to that namespace.

All conditions in a single SchemaVisibilityConfig are "AND" relationship. A caller must match all conditions to have the access. All SchemaVisibilityConfigs in the set of a blob namespace are "OR" relationship. A caller could have access if they matches any SchemaVisibilityConfig in the set.

This method provides the set of SchemaVisibilityConfig for all blob namespaces.

Returns
Map<StringSet<SchemaVisibilityConfig>> This value cannot be null.