Summary: Methods | Inherited Methods

BroadcastOptions

Kotlin |Java

public class BroadcastOptions
extends Object

java.lang.Object
↳	android.app.BroadcastOptions

Helper class for building an options Bundle that can be used with Context.sendBroadcast(Intent) and related methods.

Summary

Public methods
`boolean`	`isShareIdentityEnabled()` Returns whether the broadcasting app has opted-in to sharing its identity with the receiver.
`static BroadcastOptions`	`makeBasic()` Creates a basic `BroadcastOptions` with no options initially set.
`BroadcastOptions`	`setShareIdentityEnabled(boolean shareIdentityEnabled)` Sets whether the identity of the broadcasting app should be shared with all receivers that will receive this broadcast.
`Bundle`	`toBundle()` Returns the created options as a Bundle, which can be passed to `Context.sendBroadcast(Intent)` and related methods.

Inherited methods

From class


        
          java.lang.Object

`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

isShareIdentityEnabled

Added in Android UpsideDownCake

public boolean isShareIdentityEnabled ()

Returns whether the broadcasting app has opted-in to sharing its identity with the receiver.

Returns
`boolean`	`true` if the broadcasting app has opted in to sharing its identity

See also:

makeBasic

Added in Android UpsideDownCake

public static BroadcastOptions makeBasic ()

Creates a basic BroadcastOptions with no options initially set.

Returns
`BroadcastOptions`	an instance of `BroadcastOptions` against which options can be set This value cannot be `null`.

setShareIdentityEnabled

Added in Android UpsideDownCake

public BroadcastOptions setShareIdentityEnabled (boolean shareIdentityEnabled)

Sets whether the identity of the broadcasting app should be shared with all receivers that will receive this broadcast.

Use this option when broadcasting to a receiver that needs to know the identity of the broadcaster; with this set to true, the receiver will have access to the broadcasting app's package name and uid.

Defaults to false if not set.

Parameters
`shareIdentityEnabled`	`boolean`: whether the broadcasting app's identity should be shared with the receiver

Returns
`BroadcastOptions`	`this` `BroadcastOptions` instance This value cannot be `null`.

See also:

toBundle

Added in Android UpsideDownCake

public Bundle toBundle ()

Returns the created options as a Bundle, which can be passed to Context.sendBroadcast(Intent) and related methods. Note that the returned Bundle is still owned by the BroadcastOptions object; you must not modify it, but can supply it to the sendBroadcast methods that take an options Bundle.

Returns
`Bundle`	This value cannot be `null`.

Throws
`IllegalStateException`	if the broadcast option values are inconsistent. For example, if the delivery group policy is specified as "MERGED" but no extras merger is supplied.