Git Product home page Git Product logo

notti's Introduction

Notti

Build Status

Simple library for making quick notifications. After initialisation with config, all notifications will be displayed with same icon, light and vibrations unless you state different for specific notification. Every type of notification has same configurable options including vibrations, light settings, icon etc. For details please check usage examples.

Feel free to contribute or create issues with bugs or new features.

Usage

Add library to project dependencies.

repositories {
    maven { url "https://jitpack.io" }
}

dependencies {
    compile 'com.github.asvid:Notti:0.0.6'
}

Examples

Simple usage

public class MainActivity extends AppCompatActivity {

    private Notti notti;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        notti = new Notti(this, new NottiConf(R.drawable.ic_stat_name));

        notti.show(NottiFactory.get(NottiFactory.TYPE.STANDARD,
                                              "some text", 
                                              "some content"));
    }
}

NottiConf options

long[] pattern = {100, 200, 100, 200};
boolean shouldVibrate = true;
VibrationSettings vibrationSettings = new VibrationSettings(pattern, shouldVibrate);
//  or simply
VibrationSettings vibrationSettings = new VibrationSettings(VibrationSettings.STD_VIBRATION);

int argb = Color.BLUE;
int onMs = 300;
int offMs = 3000;
LightSettings lightSettings = new LightSettings(argb, onMs, offMs);
//  or simply
LightSettings lightSettings = new LightSettings(Color.BLUE); 

notti = new Notti(this,
        new NottiConf(R.drawable.ic_stat_name, vibrationSettings, lightSettings).setSameID(false));

Adding actions

List<NotificationAction> actionsList = Arrays.asList(
                                                    new NotificationAction("action", intent, this),
                                                    new NotificationAction("action 2", intent, this));


notti.show(NottiFactory
                .get(NottiFactory.TYPE.STANDARD, "some text", "some content")
                .setContentAction(new ContentAction(new Intent(this, MainActivity.class), this))
                .setActions(actionsList));

Using PendingIntents

notti.show(NottiFactory
                .get(NottiFactory.TYPE.STANDARD, "some text", "some content")
                .setContentAction(new ContentAction(PendingIntent.getService(context, 0, intent, 0))));

Notification types

  • STANDARD
  • INBOX
  • BIG_TEXT
  • BIG_PICTURE

Configurable methods

  • setTitle(String title);
  • setContent(String content);
  • setIcon(int icon);
  • setActions(List actions);
  • setId(int ID);
  • setBigText(String text);
  • setBigPicture(Bitmap picture);
  • setLargeIcon(Bitmap image);
  • addInboxItem(String item);
  • setInboxSummary(String summary);
  • setInboxItems(List itemList);
  • setContentAction(ContentAction contentAction);
  • setLightSettings(LightSettings lightSettings);
  • setVibrationSettings(VibrationSettings vibrations);

License

Copyright [2016] [Adam Świderski <[email protected]>]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0
    

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

notti's People

Contributors

asvid avatar

Watchers

Naseem Akhtar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.