Add @Receiver to inject the annotated receiver

@receiver

Android Receiver can be registered with code like this:

    ModuleDownloadedReceiver receiver = ...

    private void registerReceiver() {
        IntentFilter filter = new IntentFilter();
        filter.addAction("android.intent.action.DOWNLOAD_COMPLETE");
        context.registerReceiver(receiver, filter);
    }

But if the receiver has been annotated like this:

@EReceiver
public class ModuleDownloadedReceiver extends BroadcastReceiver {

    @Bean
    ModuleUtils moduleUtils;

}

... there is no annotation to inject the annotated receiver.
What I propose is a new @receiver annotation that would work pretty much like @Bean :

     @Receiver  
     ModuleDownloadedReceiver receiver ;

Why not. And it doesn't cost much :)

The second proposal of the issue #484 seems interesting to me and looks like this proposal.
The main issue is to decide when the BroadcastReceiver should be registered and unregistered (onResume/onPause or onStart/onStop or onCreate/onDestroy).

I propose an annotation @Receiver with two parameters :

actions which is an array of String indicating the action to add to the IntentFilter
registerAt (or another name) which is an enum indicating when the BroadcastReceivershould be registered and unregistered (onResume/onPause or onStart/onStop or onCreate/onDestroy).

@yDelouis

@yDelouis :+1
But then it is slightly more then.... :)

The added benefit of this annotation would be to keep the AndroidManifest leaner for BroadcastReceiver that leaves only in one Activity's context.

So with this annotation the receiver will be injected in the field and automatically registered to the context according to the chosen scope (ie registerAt).
Seems interesting. I'm planning this for 3.1

I think we should handle LocalBroadcastManager somehow. For example we could add a local method to @Receiver, which is false by default.

I added the local parameter into my PR.

Great! Thank you very much. I hope it will be merged soon.

Merged :)

Here's the updated documentation for it:

https://github.com/PerfectCarl/androidannotations/wiki/Enhance-broadcastreceivers
https://github.com/PerfectCarl/androidannotations/wiki/AvailableAnnotations

I think the doc is incorrect. @Receiver is intended to be used on methods, not fields. However we should really provide a way to inject enhanced BroadcastReceivers.

Oops, indeed. The final implementation is very different from my initial proposal.
Okay, I need to do some more research about this :)

Okay, I played with the feature (which I should have done in the first place) and fixed the documentation

https://github.com/PerfectCarl/androidannotations/wiki/Enhance-broadcastreceivers
https://github.com/PerfectCarl/androidannotations/wiki/AvailableAnnotations
https://github.com/PerfectCarl/androidannotations/wiki/Receiving-intents

https://github.com/PerfectCarl/androidannotations/wiki/Enhance-Fragments
https://github.com/PerfectCarl/androidannotations/wiki/Enhance-services

I read the updated doc, very nice work!

Added IntentService #1019 :)

Navigation Menu

Repository navigation

Add @Receiver to inject the annotated receiver #852

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Add @Receiver to inject the annotated receiver #852

Description

Activity

DayS commented on Jan 2, 2014

yDelouis commented on Jan 2, 2014

PerfectCarl commented on Jan 3, 2014

DayS commented on Jan 3, 2014

WonderCsabo commented on Jan 12, 2014

yDelouis commented on Jan 13, 2014

WonderCsabo commented on Jan 13, 2014

DayS commented on Mar 16, 2014

PerfectCarl commented on May 28, 2014

WonderCsabo commented on May 28, 2014

PerfectCarl commented on May 28, 2014

PerfectCarl commented on May 29, 2014

WonderCsabo commented on May 31, 2014

PerfectCarl commented on May 31, 2014

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions