/**@class android.content.BroadcastReceiver @extends java.lang.Object Base class for code that receives and handles broadcast intents sent by {@link android.content.Context#sendBroadcast(Intent)}. <p>You can either dynamically register an instance of this class with {@link android.content.Context#registerReceiver android.content.Context.registerReceiver()} or statically declare an implementation with the {@link android.R.styleable#AndroidManifestReceiver <receiver>} tag in your <code>AndroidManifest.xml</code>. <div class="special reference"> <h3>Developer Guides</h3> <p>For more information about using BroadcastReceiver, read the <a href="{@docRoot}guide/components/broadcasts.html">Broadcasts</a> developer guide.</p></div> */ var BroadcastReceiver = { /**This method is called when the BroadcastReceiver is receiving an Intent broadcast. During this time you can use the other methods on BroadcastReceiver to view/modify the current result values. This method is always called within the main thread of its process, unless you explicitly asked for it to be scheduled on a different thread using {@link android.content.Context#registerReceiver(BroadcastReceiver, IntentFilter, String, android.os.Handler)}. When it runs on the main thread you should never perform long-running operations in it (there is a timeout of 10 seconds that the system allows before considering the receiver to be blocked and a candidate to be killed). You cannot launch a popup dialog in your implementation of onReceive(). <p><b>If this BroadcastReceiver was launched through a <receiver> tag, then the object is no longer alive after returning from this function.</b> This means you should not perform any operations that return a result to you asynchronously. If you need to perform any follow up background work, schedule a {@link android.app.job.JobService} with {@link android.app.job.JobScheduler}. If you wish to interact with a service that is already running and previously bound using {@link android.content.Context#bindService(Intent, ServiceConnection, int) bindService()}, you can use {@link #peekService}. <p>The Intent filters used in {@link android.content.Context#registerReceiver} and in application manifests are <em>not</em> guaranteed to be exclusive. They are hints to the operating system about how to find suitable recipients. It is possible for senders to force delivery to specific recipients, bypassing filter resolution. For this reason, {@link #onReceive(Context, android.content.Intent) onReceive()} implementations should respond only to known actions, ignoring any unexpected Intents that they may receive. @param {Object {Context}} context The Context in which the receiver is running. @param {Object {Intent}} intent The Intent being received. */ onReceive : function( ) {}, /**This can be called by an application in {@link #onReceive} to allow it to keep the broadcast active after returning from that function. This does <em>not</em> change the expectation of being relatively responsive to the broadcast, but does allow the implementation to move work related to it over to another thread to avoid glitching the main UI thread due to disk IO. <p>As a general rule, broadcast receivers are allowed to run for up to 10 seconds before they system will consider them non-responsive and ANR the app. Since these usually execute on the app's main thread, they are already bound by the ~5 second time limit of various operations that can happen there (not to mention just avoiding UI jank), so the receive limit is generally not of concern. However, once you use {@code goAsync}, though able to be off the main thread, the broadcast execution limit still applies, and that includes the time spent between calling this method and ultimately {@link android.content.BroadcastReceiver.PendingResult#finish() android.content.BroadcastReceiver.PendingResult.finish()}.</p> <p>If you are taking advantage of this method to have more time to execute, it is useful to know that the available time can be longer in certain situations. In particular, if the broadcast you are receiving is not a foreground broadcast (that is, the sender has not used {@link android.content.Intent#FLAG_RECEIVER_FOREGROUND}), then more time is allowed for the receivers to run, allowing them to execute for 30 seconds or even a bit more. This is something that receivers should rarely take advantage of (long work should be punted to another system facility such as {@link android.app.job.JobScheduler}, {@link android.app.Service}, or see especially {@link android.support.v4.app.JobIntentService}), but can be useful in certain rare cases where it is necessary to do some work as soon as the broadcast is delivered. Keep in mind that the work you do here will block further broadcasts until it completes, so taking advantage of this at all excessively can be counter-productive and cause later events to be received more slowly.</p> @return {Object {android.content.BroadcastReceiver.PendingResult}} Returns a {@link PendingResult} representing the result of the active broadcast. The BroadcastRecord itself is no longer active; all data and other interaction must go through {@link PendingResult} APIs. The {@link PendingResult#finish PendingResult.finish()} method must be called once processing of the broadcast is done. */ goAsync : function( ) {}, /**Provide a binder to an already-bound service. This method is synchronous and will not start the target service if it is not present, so it is safe to call from {@link #onReceive}. For peekService() to return a non null {@link android.os.IBinder} interface the service must have published it before. In other words some component must have called {@link android.content.Context#bindService(Intent, ServiceConnection, int)} on it. @param {Object {Context}} myContext The Context that had been passed to {@link #onReceive(Context, Intent)} @param {Object {Intent}} service Identifies the already-bound service you wish to use. See {@link android.content.Context#bindService(Intent, ServiceConnection, int)} for more information. */ peekService : function( ) {}, /**Change the current result code of this broadcast; only works with broadcasts sent through {@link android.content.Context#sendOrderedBroadcast(Intent, String) android.content.Context.sendOrderedBroadcast}. Often uses the Activity {@link android.app.Activity#RESULT_CANCELED} and {@link android.app.Activity#RESULT_OK} constants, though the actual meaning of this value is ultimately up to the broadcaster. <p class="note">This method does not work with non-ordered broadcasts such as those sent with {@link android.content.Context#sendBroadcast(Intent) android.content.Context.sendBroadcast}</p> @param {Number} code The new result code. @see #setResult(int, String, Bundle) */ setResultCode : function( ) {}, /**Retrieve the current result code, as set by the previous receiver. @return {Number} int The current result code. */ getResultCode : function( ) {}, /**Change the current result data of this broadcast; only works with broadcasts sent through {@link android.content.Context#sendOrderedBroadcast(Intent, String) android.content.Context.sendOrderedBroadcast}. This is an arbitrary string whose interpretation is up to the broadcaster. <p><strong>This method does not work with non-ordered broadcasts such as those sent with {@link android.content.Context#sendBroadcast(Intent) android.content.Context.sendBroadcast}</strong></p> @param {String} data The new result data; may be null. @see #setResult(int, String, Bundle) */ setResultData : function( ) {}, /**Retrieve the current result data, as set by the previous receiver. Often this is null. @return {String} String The current result data; may be null. */ getResultData : function( ) {}, /**Change the current result extras of this broadcast; only works with broadcasts sent through {@link android.content.Context#sendOrderedBroadcast(Intent, String) android.content.Context.sendOrderedBroadcast}. This is a Bundle holding arbitrary data, whose interpretation is up to the broadcaster. Can be set to null. Calling this method completely replaces the current map (if any). <p><strong>This method does not work with non-ordered broadcasts such as those sent with {@link android.content.Context#sendBroadcast(Intent) android.content.Context.sendBroadcast}</strong></p> @param {Object {Bundle}} extras The new extra data map; may be null. @see #setResult(int, String, Bundle) */ setResultExtras : function( ) {}, /**Retrieve the current result extra data, as set by the previous receiver. Any changes you make to the returned Map will be propagated to the next receiver. @param {Boolean} makeMap If true then a new empty Map will be made for you if the current Map is null; if false you should be prepared to receive a null Map. @return {Object {android.os.Bundle}} Map The current extras map. */ getResultExtras : function( ) {}, /**Change all of the result data returned from this broadcasts; only works with broadcasts sent through {@link android.content.Context#sendOrderedBroadcast(Intent, String) android.content.Context.sendOrderedBroadcast}. All current result data is replaced by the value given to this method. <p><strong>This method does not work with non-ordered broadcasts such as those sent with {@link android.content.Context#sendBroadcast(Intent) android.content.Context.sendBroadcast}</strong></p> @param {Number} code The new result code. Often uses the Activity {@link android.app.Activity#RESULT_CANCELED} and {@link android.app.Activity#RESULT_OK} constants, though the actual meaning of this value is ultimately up to the broadcaster. @param {String} data The new result data. This is an arbitrary string whose interpretation is up to the broadcaster; may be null. @param {Object {Bundle}} extras The new extra data map. This is a Bundle holding arbitrary data, whose interpretation is up to the broadcaster. Can be set to null. This completely replaces the current map (if any). */ setResult : function( ) {}, /**Returns the flag indicating whether or not this receiver should abort the current broadcast. @return {Boolean} True if the broadcast should be aborted. */ getAbortBroadcast : function( ) {}, /**Sets the flag indicating that this receiver should abort the current broadcast; only works with broadcasts sent through {@link android.content.Context#sendOrderedBroadcast(Intent, String) android.content.Context.sendOrderedBroadcast}. This will prevent any other broadcast receivers from receiving the broadcast. It will still call {@link #onReceive} of the BroadcastReceiver that the caller of {@link android.content.Context#sendOrderedBroadcast(Intent, String) android.content.Context.sendOrderedBroadcast} passed in. <p><strong>This method does not work with non-ordered broadcasts such as those sent with {@link android.content.Context#sendBroadcast(Intent) android.content.Context.sendBroadcast}</strong></p> */ abortBroadcast : function( ) {}, /**Clears the flag indicating that this receiver should abort the current broadcast. */ clearAbortBroadcast : function( ) {}, /**Returns true if the receiver is currently processing an ordered broadcast. */ isOrderedBroadcast : function( ) {}, /**Returns true if the receiver is currently processing the initial value of a sticky broadcast -- that is, the value that was last broadcast and is currently held in the sticky cache, so this is not directly the result of a broadcast right now. */ isInitialStickyBroadcast : function( ) {}, /**For internal use, sets the hint about whether this BroadcastReceiver is running in ordered mode. */ setOrderedHint : function( ) {}, /**For internal use to set the result data that is active. @hide */ setPendingResult : function( ) {}, /**For internal use to set the result data that is active. @hide */ getPendingResult : function( ) {}, /** @hide */ getSendingUserId : function( ) {}, /**Control inclusion of debugging help for mismatched calls to {@link android.content.Context#registerReceiver(BroadcastReceiver, IntentFilter) android.content.Context.registerReceiver()}. If called with true, before given to registerReceiver(), then the callstack of the following {@link android.content.Context#unregisterReceiver(BroadcastReceiver) android.content.Context.unregisterReceiver()} call is retained, to be printed if a later incorrect unregister call is made. Note that doing this requires retaining information about the BroadcastReceiver for the lifetime of the app, resulting in a leak -- this should only be used for debugging. */ setDebugUnregister : function( ) {}, /**Return the last value given to {@link #setDebugUnregister}. */ getDebugUnregister : function( ) {}, };