build.gradle مربوط به اپلیکیشن وارد شوید. مراقب باشید اشتباها به فایل gradle مربوط به پروژه وارد نشوید.dependencies اضافه کنید.implementation 'co.ronash.android:pushe-base:1.6.3'
برای استفاده از قابلیت های اندروید 8 مانند notification channel بایستی TargetSDK برابر 26 یا بالاتر باشد.
gradle سینک شود.در فایل build.gradle مربوط به پروژه مطمئن شوید که لینک های لازم برای دریافت پوشه و کتابخانه های ساپورت موجود هستند
allprojects {
repositories {
google()
jcenter()
//...
}
}
AndroidManifest.xml پروژه خود اضافه کنید.manifest
در فایل منیفست خود بگذارید.<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
امکانات زیر موقعیت‌محور هستند و برای استفاده از آنها دسترسی موقعیت مکانی لازم است:
import ، کد روبرو را وارد کنید.import co.ronash.pushe.Pushe;
onCreate کد روبرو را وارد کنید.Pushe.initialize(context,true);
true گذاشته شود و دستگاه کاربر شما گوگل پلی سرویس نداشته باشد و یا آن را غیرفعال کرده باشد دیالوگی باز می شود و به کاربر پیشنهاد نصب گوگل پلی سرویس داده می شود تا قابلیت دریافت و ارسال پوش نوتیفیکیشن فعال شود. اگر در تابع بالا false را قرار دهید، این دیالوگ برای کاربر باز نمی شود.پس از اینکه فایل کتابخانه را مطابق با آموزش داده شده نصب کردید، میتوانید پروژه را اجرا و بر روی دستگاه خود نصب و تست کنید.
اگر می خواهید اپلیکیشن را بر روی Emulator تست کنید، بر روی ایمولاتور شما باید Google API نصب باشد.
پوشه برای دریافت اعلان از از سرویس FCM گوگل استفاده می‌کند. در صورتی که پوشه تنها سرویسی در اپلیکیشن شما باشد که از این سرویس استفاده می‌کند، با دنبال کردن همان مراحلی که در قسمت راه‌اندازی توصیح داده شد همه چیز به درستی کار خواهد کرد و نیازی به انجام کار اضافه‌ای برای راه اندازی FCM نیست.
ولی در مواردی که غیر از پوشه سرویس دیگری نیز بخواهد از FCM استفاده کند، مثلا اگر خود شما بخواهید مستقیما از Firebase استفاده کنید و پیغام‌های FCM دریافت کنید، تداخل پیش خواهد آمد چرا که در هر اپلیکیشن تنها یک سرویس گوش‌دهنده به پیغام‌های FCM می‌تواند وجود داشته باشد. اگر بیش از یک سرویس گوش‌دهنده تعریف شود، پیغام‌هایی که به اپلیکیشن می‌رسند به صورت تصادفی تنها به دست یکی از این سرویس‌ها خواهد رسید و این باعث مختل شدن عملیات برنامه می‌شود.
برای رفع این مشکل لازم است مراحل زیر را در راه اندازی طی کنید:
با طی کردن این مراحل، تنها گوش دهنده به پیغام‌های FCM گوش دهنده تعریف شده شما خواهد بود که همه‌ی پیغام‌های FCM را دریافت خواهد کرد و پیغام‌های مربوط به پوشه را به کتابخانه‌ی پوشه تحویل می‌دهد.
در ادامه نحوه اعمال این مراحل را قدم به فدم توضیح می‌دهیم:
برای غیر فعال کردن سرویس
FCM
پوشه، عبارت زیر را در تگ
<application>
فایل منیفست خود بگذارید:
<service
android:name="co.ronash.pushe.fcm.FcmService"
tools:node="remove" />
در صورتی که با پیغام خطا مواجه شدید بررسی کنید که عبارت
xmlns:tools="http://schemas.android.com/tools"
در پارامتر‌های تگ
<manifest>
ابتدای فایل وجود داشته باشد، به این شکل:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
package="..."/>
در صورتی که از قبل سرویس FCM برای برنامه‌ی خود ایجاد کرده‌اید میتوانید از این مرحله بگذرید.
یک کلاس جدید بسازید که از کلاس
FirebaseMessagingService
ارث می‌برد. در مثال زیر اسم کلاس را
MyFcmService
گذاشتیم ولی شما میتوانید اسم دلخواه خود را استفاده کنید.
public class MyFcmService extends FirebaseMessagingService {
}
سرویس جدید را با گذاشتن عبارت زیر در تگ
<application>
فایل منیفست خود فعال کنید. توجه داشته باشید که نام کلاس را با نام کلاس تعریف شده خود جایگزین کنید.
<service android:name=".MyFcmService">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
در کلاس تعریف شده در مرحله قبل، تابع‌های زیر را به همراه کد داخل آنها پیاده‌سازی کنید:
public class MyFcmService extends FirebaseMessagingService {
@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
if (Pushe.getFcmHandler(this).onMessageReceived(remoteMessage)) {
// Message belongs to Pushe, no further action needed
return;
}
// Message does not belong to Pushe, process message...
}
@Override
public void onNewToken(String s) {
Pushe.getFcmHandler(this).onNewToken(s);
}
@Override
public void onMessageSent(String s) {
Pushe.getFcmHandler(this).onMessageSent(s);
}
@Override
public void onSendError(String s, Exception e) {
Pushe.getFcmHandler(this).onSendError(s, e);
}
@Override
public void onDeletedMessages() {
Pushe.getFcmHandler(this).onDeletedMessages();
}
}
هر بار که یک پیغام
FCM
به برنامه شما می‌رسد، تابع
onMessageReceived
کلاس شما صدا زده می‌شود. همانطور که در مثال بالا مشاهده می‌کنید در پیاده‌سازی این تابع، شما با استفاده از عبارت زیر پوشه را از دریافت پیغام مطلع می‌کنید:
Pushe.getFcmHandler(this).onMessageRecevied(remoteMessage)
با این کار پیغام به دست پوشه نیز می‌رسد و اگر پیغام مربوط به کتابخانه‌ی پوشه باشد عملیات لازم بر روی آن انجام می‌شود. در صورتی که پیغام مربوط به پوشه باشد عبارت بالا مقدار
true
بر می‌گرداند و شما نیازی نیست عملیات بیشتری روی این پیغام انجام دهید. در صورتی که از عبارت بالا مقدار
false
گرفتید به این معنی است که پیغام مربوط به پوشه نیست و شما باید بسته به نیاز خود عملیات مورد نظر را برای آن انجام دهید.
سایر توابع کلاس تعریف شده زمان رخ دادن رویداد‌های مختلف مربوط به FCM صدا زده می‌شوند. همانطور که در مثال بالا نشان داده شده، نیاز است که شما هنگام رخ دادن این رویدادها با صدا زدن تابع مربوطه از کتابخانه‌ی پوشه، پوشه را از رخ دادن این رویدادها مطلع کنید.
این شناسه برای یکتاسازی دستگاه‌هایی که پوشه در آنها رجیسترشده استفاده‌می‌شود. برای گرفتن شناسه‌ی پوشه‌ی دستگاهی که برنامه در آن نصب شده از کد زیر استفاده کنید.
String pusheId = Pushe.getPusheId(context);
شما میتوانید از طریق پنل برای اپلیکیشن خود اطلاعات دلخواه در قالب یک JSON ارسال کنید. برای اینکه بتوانید از این اطلاعات در اپلیکیشن خود استفاده کنید مراحل زیر را انجام دهید.
AndroidManifest.xml داخل بدنه تگ <application> اضافه کنید.<service
android:name=".MyPushListener"
android:exported="false">
<intent-filter>
<action android:name="co.ronash.pushe.RECEIVE" />
</intent-filter>
</service>
<!--PushListener can be somewhere else according to your packaging-->
class جدید ایجاد کنید و برای آن یک نام انتخاب کنید. پیشنهاد ما نام MyPushListener می باشد.PusheListenerService و JSONObject که به رنگ قرمز در آمده اند رفته و کلید Alt+Enter را بزنید تا کتابخانه‌های مربوطه به پروژه شما اضافه شوند.public class MyPushListener extends PusheListenerService {
@Override
public void onMessageReceived(JSONObject customContent,JSONObject pushMessage){
android.util.Log.i("Pushe","Custom json Message: "+ customContent.toString());
// Your Code
}
}
JSON دریافت می‌شود و با قرار دادن کد خود به جای // Your Code میتوانید از آن استفاده کنید.PusheListenerService ارث بری می‌کنید، داخل متد onMessageReceived دو شیء از نوع JSONObject دریافت می‌کنید که پارامتر اول JSON ارسالی و پارامتر دوم محتوای پوش نمایش داده شده است.JSON ارسالی خود کلید‌های content و title را دارید و می‌خواهید آن را در LogCat نشان دهید، این کد را اضافه می‌کنید:مثال: JSON ارسال شده
{
"title": "تیتر",
"content": "متن"
}
/**
* {@link PusheListenerService} extends Service class, so you have access to context using `this`.
*/
public class MyPushListener extends PusheListenerService{
@Override
public void onMessageReceived(JSONObject customContent,JSONObject pushMessage) {
if (customContent == null || customContent.length() == 0)
return; //json is empty
android.util.Log.i("Pushe","Custom json Message: "+ customContent.toString()); //print json to logCat
//Do something with json
try{
String s1 = customContent.getString("title");
String s2 = customContent.getString("content");
android.util.Log.i("Pushe","Json Message\n title: " + s1 + "\n content: " + s2);
} catch (Exception e) {
android.util.Log.e("TAG","Exception in parsing json" ,e);
}
}
به همین ترتیب اگر شما مقادیر int یا boolean در JSON ارسالی گذاشته اید، با دستورهای
message.getInt(نام کلید)
message.getBoolean(نام کلید)
آن مقدار را از JSON دریافتی می‌گیرید و برحسب اینکه می‌خواهید با آن چه کاری انجام دهید، کد لازم را اضافه می‌کنید.
شما میتوانید با ثبت یک رسیور در برنامه‌تان، از کلیک شدن یا رد کردن اعلان مطلع شوید. برای این کار یک BroadcastReceiver در فایل AndroidManifest.xml برنامه خودتان اضافه کنید و اینتنت فیلترهای زیر را در آن اضافه کنید. سه اینتنت فیلتر برای سه اتفاق زدن بر روی اعلان، رد کردن اعلان و کلیک شدن دکمه‌ای از اعلان معرفی شده است. میتوانید هر سه را استفاده کنید یا فقط یکی یا دو تا را بسته به نیازمندی خودتان مشخص کنید.
<receiver android:name=".NotificationStatusReceiver">
<intent-filter>
<action android:name="PACKAGE_NAME.pusheco.NOTIF_CLICKED"/>
<action android:name="PACKAGE_NAME.pusheco.NOTIF_DISMISSED" />
<action android:name="PACKAGE_NAME.pusheco.NOTIF_BTN_CLICKED" />
</intent-filter>
</receiver>
در کلاس BroadcastReceiver هم کدی شبیه به زیر اضافه کنید:
PACKAGE_NAME همان نام پکیج شماست.public class NotificationStatusReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
String packageName = context.getPackgeName();
String clicked = packageName + ".pusheco.NOTIF_CLICKED";
String dismissed = packageName + ".pusheco.NOTIF_DISMISSED";
String buttonClicked = packageName + ".pusheco.NOTIF_BTN_CLICKED";
Strign action = intent.getAction() == null ? "" : intent.getAction();
if(action.equals(clicked)){
Log.i("Pushe","Notification clicked");
//add your logic here
}
else if(action.equals(dismissed)){
Log.i("Pushe", "Notification dismissed.");
//add your logic here
}
else if(action.equals(buttonClicked)){
String btnId = intent.getStringExtra("pushe_notif_btn_id");
Log.i("Pushe", "Notification button clicked. Button: " + btnId);
//add your logic here
}
}
}
در حالتی که یک دکمه اعلان کلیک شود، شناسه آن دکمه را که یکی از اعداد ۱ تا ۳ هست میتوانید داشته باشید و از روی آن اینکه چه دکمه‌ای کلیک شده است را متوجه می‌شوید.
شما میتوانید کاربران خود را در تاپیک یا تاپیک‌های متفاوت ثبت نام کنید و برحسب علاقمندی کاربران یا دسته‌بندی خودتان به تاپیک مرتبط پوش بفرستید. مثلا اگر شما اپلیکیشن خبری دارید و کاربرانی به اخبار ورزشی علاقمند هستند و عده ای به اخبار فرهنگی، می توانید دسته اول را در تاپیک ورزشی و دسته دوم را در تاپیک فرهنگی ثبت نام کنید و هنگام ارسال پوش، برحسب محتوای پوش‌تان به تاپیک مرتبط آن را ارسال کنید تا فقط کاربران علاقمند به آن موضوع آن را دریافت کنند.
برای استفاده از این امکان باید کاربران خود را در تاپیک مورد نظر عضو کنید. فرض کنید نام تاپیک مورد نظرتان sport باشد. برای عضویت در این تاپیک از دستور زیر استفاده کنید:
Pushe.subscribe(context, "sport");
برای لغو عضویت از این تاپیک از دستور زیر استفاده کنید:
Pushe.unsubscribe(context, "sport");
توجه داشته باشید که توابع مربوط به عضو شدن و لغو عضویت در تاپیک باید بعد از پایان Pushe.initialize اجرا شوند. بنابراین آنها را بلافاصله بعد از Pushe.initialize قرار ندهید.
میتوانید نمایش پوش را غیرفعال کنید. مثلا در تنظیمات اپلیکیشن خود امکان دریافت نکردن پوش را برای کاربر قرار دهید و طبق انتخاب کاربر آن را فعال یا غیرفعال کنید. برای غیرفعال کردن نمایش پوش از دستور زیر استفاده کنید:
Pushe.setNotificationOff(context);
برای فعال سازی دوباره ی نمایش پوش از دستور زیر استفاده کنید:
Pushe.setNotificationOn(context);
میتوانید مستقیم از یک دستگاه به دستگاه دیگر اعلان بفرستید. برای این کار باید شناسه‌ی پوشه‌ی آن دستگاه یعنی Pushe id آن را داشته باشید. برای بدست آوردن شناسه هر دستگاه می توانید به روش زیر عمل کنید:
String devicePusheId = Pushe.getPusheId(context);
به این روش pid هر دستگاه را می توانید بدست بیاورید و آنها را در سرور خود ذخیره کنید تا برای ارسال اعلان به دستگاه از آن استفاده کنید.
String pusheId = "some_thing";
Pushe.sendSimpleNotifToUser(context, pusheId, "title", "content");
context، پارامتر دوم pusheId است و پارامتر سوم و چهارم به ترتیب تیتر و متن اعلان هستند.String pusheId = "some_thing";
Pushe.sendAdvancedNotifToUser(context, pusheId, "{ \"title\":\"Hello\", \"content\":\"World!\" }");
context، پارامتر دوم pusheId است و پارامتر سوم یک رشته با فرمت JSON هست که مشخصات اعلان پیشرفته را تعیین می کند.نمونه‌ی یک جیسون کامل برای ارسال:
{
"title": "عنوان",
"content": "تیتر",
"big_title": "تیتر کامل",
"big_content": "متن بزرگ",
"summary": "چکیده ",
"image": "http://url/name.png",
"icon": "http://url/name.png",
"ticker": "متن نوار اعلان",
"notif_icon": "file_download",
"wake_screen": true,
"sound_url": "http://static.pushe.co/mp3/2.mp3",
"visibility": true,
"led_color": "-8206336",
"show_app": true,
"led_on": 300,
"led_off": 500,
"delay_until": true,
"action": {
"url": "tg://join?invite=sdfdsfdsfds",
"action_type": "U"
},
"buttons": [
{
"btn_icon": "fileـdownload",
"btn_order": 1,
"btn_content": "متن دکمه",
"btn_action": {
"url": "tg://join?invite=fdsfdsfds",
"action_type": "U"
}
},
{
"btn_icon": "local_cafe",
"btn_order": 2,
"btn_content": "متن دکمه",
"btn_action": {
"url": "http://fgfdgfdg.com",
"action_type": "U"
}
},
{
"btn_icon": "phone_android",
"btn_order": 3,
"btn_content": "متن دکمه",
"btn_action": {
"url": "call:a_number",
"action_type": "U"
}
}
]
}
برای اطلاعات بیشتر در مورد کلید‌ها و نحوه‌ی آنها به ارسال با استفاده از API مراجعه کنید.
JSON دلخواه از دستور زیر استفاده کنید:String pusheId = "some_thing";
Pushe.sendCustomJsonToUser(context, pusheId, "{ \"key1\":\"value1\", \"key2\":\"value2\" }");
در این حالت پارامتر سوم یک رشته با فرمت JSON هست که اطلاعاتی که می خواهید ارسال کنید را به فرمت JSON داخلش دارد.
نکته مهم: توابع ارسال اعلان به دستگاه دیگر و عضویت یا لغو عضویت در تاپیک را بعد از اطمینان از اینکه عملیات initialization پوشه انجام شده است، صدا بزنید. برای این کار به روش زیر عمل کنید:
if (Pushe.isPusheInitialized(context)) {
Pushe.sendSimpleNotifToUser(context, "pid_a0e3-82ac-a0", "title", "content");
}
در صورتی که قصد دارید که به دیوایسی که در حال اجرای این کد است اعلان بفرستید کافیست که شناسه‌ی ورودی را برابر شناسه‌ی دستگاه قرار دهید:
Pushe.sendSimpleNotifToUser(Pushe.getPusheId(context), title, content);
در اندروید ۸ به بعد قابلیتی برای تعریف کانال نوتیفیکیشن در اپلیکیشن ایجاد شده است. به این شکل که در برنامه خود یک یا چند کانال نوتیفیکیشن تعریف می کنید و در زمان ارسال اعلان پیشرفته با وارد کردن Channel-Id آن کانال میتوانید اعلان را برای آن کانال خاص ارسال کنید.
مزیت این کار این هست که کاربر می تواند دریافت نوتیفیکیشن از بعضی کانال‌ها را غیرفعال کند و همچنان می‌تواند از یک یا چند کانال دیگر اعلان بگیرد. فراخوانی تابع ایجاد یا حذف کانال در حالتی که برنامه شما روی اندروید زیر ۸ اجرا شود، اثری ندارد. همچنین اگر بیشتر از یکبار تابع ایجاد کانال را صدا بزنید هم فقط یکبار کانال ایجاد می‌شود و مشکلی ایجاد نمی‌کند.
با استفاده از دستور زیر در برنامه خود می توانید کانال نوتیفیکشن تعریف کنید:
Pushe.createNotificationChannel(
context,
"MY_CHANNEL_ID", //channelId
"all news channel", //Channel Name
"", //description about channel
4, //importance: Number between 0 to 5 (5 is the most important)
true, //enableLight
true, //enableViberation
true, //showBadge
Color.BLUE, //led color
new long[]{100, 200, 300, 400, 500, 400, 300, 200, 400} // Vibrate mode (can be Nullable)
);
با استفاده از تابع زیر در برنامه خود میتوانید کانال نوتیفیکشنی که قبلا ایجاد کردید را حذف کنید:
Pushe.removeNotificationChannel(
context,
"MY_CHANNEL_ID"
);
شما میتوانید خطاهای عمومی موجود در هنگام نصب در اندروید را در این لینک مشاهده نمایید. موارد عنوان شده در زیر تنها مربوط به اندروید استودیو هستند.
در صورتی که خطای خود را در عیب‌یابی نیافتید به ما اطلاع‌دهید تا آن را اضافه‌کنیم.
با توجه به اینکه سایت Jcenter خدمات به ایران را محدود کرده است در صورتی که با این خطا مواجه شده‌اید، پراکسی شما مشکل دارد و باید از پراکسی مناسب استفاده کنید.
این خطا غالبا به دلیل مشکلی که برای گریدل به‌وجود آمده، رخ می‌دهد و به این دلیل است که گریدل در دریافت و قراردادنِ یک لایبرری به مشکل برخورده‌است. برای حل این مشکل میتوانید موارد زیر را امتحان کنید:
C:\Users\user_name\.gradle\caches/home/user_name/.gradle/cachesbuild.gradle تغییر دهید.در صورتی که از AndroidX در برنامه استفاده می‌کنید باید در نظر داشته‌باشید پوشه از android support library استفاده می‌کند و برای جلوگیری از خطاهای مربوط، Jettifier را فعال کنید.
به فایل gradle.properties خطوط زیر را اضافه کنید (فایل مختص پروژه و نه Global).
android.useAndroidX=true
android.enableJetifier=true
در صورتی که پس از اضافه‌کردن پوشه یک کتابخانه با دو نسخه‌ی متفاوت اضافه‌شدند و خطای نسخه‌ی متفاوت رخ‌داد، بایستی کتابخانه را با نسخه‌ی بالاتر به گریدل اضافه کنید. پوشه از کتابخانه‌ی فایربیس نسخه‌ی ۱۷.۴.۰ استفاده می‌کند و شما یک کتابخانه‌ی دیگر از نسخه‌ی پایینتری مثلا ۱۶.۰.۱ استفاده می‌کنید. برای حل مشکل، در صورتی که کتابخانه‌ی ذکرشده توسط شما اضافه‌شده، نسخه‌ی آنرا به نسخه‌ی پوشه برسانید و در صورتی که توسط یک کتابخانه‌ی دیگر اضافه‌شده، خودتان آن کتابخانه را اضافه کنید و نسخه‌ی بالاتر را برای آن قرار دهید.
در پوشه از کتابخانه ی support-v4 استفاده شده است. لذا اندروید استودیو اقدام به دانلود ملزومات کتابخانه از ریپازیتوری مربوطه خواهد کرد. در صورتی که به هردلیل در انجام این امر ناموفق باشد خطای بالا را خواهید دید.
برای اطلاعات بیشتر میتوانید سوال مربوط به آن در سایت استک اور فلو را بررسی کنید.
این دسترسی برای ارسال اعلان برحسب موقعیت مکانی کاربر هست. می توانید آن را حذف کنید اما دراینصورت اعلان پیشرفته برحسب مکان کاربر برای شما درست کار نخواهد کرد.
با اضافه کردن تگ زیر به Manifest می توانید این دسترسی را حذف کنید:
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" tools:node="remove"/>
با اضافه‌کردن این خط پرمیشن از مانیفست نهایی حذف خواهد شد.
در صورتی که از نسخه ی 17 سرویس های لوکیشن، gcm و ad استفاده کنید ممکن است به این خطا برخورد کنید. برای رفع آن بایستی متادیتای زیر را داخل تگ اپلیکیشن در مانیفست اضافه کنید.
<meta-data
android:name="com.google.android.gms.ads.AD_MANAGER_APP"
android:value="true" />
در این صورت موارد لازم برای ادامه‌ی کار مهیا خواهند شد.
در این حالت یک کلاس یکسان از دو پکیج اضافه‌شده که به طوری که گریدل نتوانسته این مورد را رفع کند. برای حل این مورد باید مورد تکراری را بیابید و آنرا دستی رفع کنید. در صورتی که یک لایبرری را به صورت فایلی به پروژه اضافه‌کرده‌اید، بهتر است تا حد امکان از حالت کد دپندنسی استفاده‌کنید.
این مورد بدین معنی ست که تعداد متد‌های ساخته‌شده بیشتر از تعدادی‌ست که ماشین‌مجازی اندروید می‌تواند آدرس‌دهی کند. برای حل این موضوع باید مالتی‌دکس را در پروژه فعال کنید. برای اطلاعات بیشتر میتوانید به داکیومنت‌های اندروید مراجعه کنید.
در اولین فرصت با ایمیل به شما پاسخ خواهیم داد.
شاید جواب سوال شما اینجا باشد: سوالات متداول ، مستندات