کتابخانه پوشمتریکس برای Android
- راهاندازی کتابخانه در اپلیکیشن اندروید
- امکانات و قابلیتها
- شناسهها و توکنها
- اختصاص شناسه سفارشی به کاربران
- متد MetrixNotification.setUserEmail
- متد MetrixNotification.setUserPhoneNumber
- متد MetrixNotification.setCustomId
- دریافت شناسه یکتا کاربر
- دریافت مقدار شناسههای سفارشی
- متد MetrixNotification.getUserEmail
- متد MetrixNotification.getUserPhoneNumber
- متد MetrixNotification.getCustomId
- توکن اختصاصی سرویس فایربیس
- گروهبندی کاربران
- تاپیک (topic)
- عضویت کاربر در تاپیک
- لغو عضویت کاربر از تاپیک
- تگ (tag)
- اضافهکردن تگ
- حذف تگ از لیست تگها
- گرفتن لیست تگها
- ارسال اعلان از طریق کد
- ارسال اعلان به دستگاه اجراکنندهی کد
- رویدادهای مرتبط با نوتیفیکیشن
- غیرفعالکردن نمایش اعلان
- بررسی وضعیت فعال یا غیرفعال بودن نمایش اعلان
- کانال نوتیفیکیشن
- اضافهکردن کانال نوتیفیکیشن
- حذف کانال نوتیفیکیشن
پروژه نمونه پیادهسازی پوشمتریکس را میتوانید در اینجا ملاحظه نمایید.
۱. مخزن متریکس را در فایل build.gradle
مربوط به پروژه خود در قسمت allprojects
اضافه کنید:
allprojects {
repositories {
// ...
mavenCentral()
}
}
۲. وابستگی مربوط به کتابخانه پوشمتریکس را در قسمت dependencies
فایل build.gradle
اپلیکیشن خود وارد کنید:
implementation 'ir.metrix.push:metrix:1.1.3'
۳. شناسه اپلیکیشن و شناسه ارسال پوش خود را در فایل AndroidManifest.xml
به صورت زیر وارد کنید:
<manifest>
...
<application>
...
<!-- خطوط زیر را اضافه کنید و شناسه اپلیکیشن خود را جایگزین نمایید -->
<meta-data
android:name="metrix_appId"
android:value="APP_ID" />
<!-- خطوط زیر را اضافه کنید و شناسه پوش اپلیکیشن خود را جایگزین نمایید -->
<!-- این شناسه با فعالسازی پوش در تنظیمات اپلیکیشن در اختیار شما قرار میگیرد -->
<meta-data
android:name="metrix_push_appId"
android:value="PUSH_APP_ID" />
</application>
</manifest>
۳. فایل google-services.json
مربوط به اپلیکیشن خود که از پنل فایربیس خود دریافت میکنید را در آدرس اصلی اپلیکیشن خود قرار دهید:
۴. جهت اضافهشدن پلاگین Google services
وابستگی زیر را در فایل build.gradle
سطح پروژه خود اضافه کنید:
buildscript {
...
dependencies {
...
// خط زیر را اضافه نمایید
classpath 'com.google.gms:google-services:4.3.4'
}
}
سپس پلاگین را در فایل build.gradle
اپلیکیشن خود اضافه کنید:
apply plugin: 'com.android.application'
// خط زیر را اضافه نمایید
apply plugin: 'com.google.gms.google-services'
جهت مشاهده امکانات و قابلیتهای مرتبط با کتابخانه متریکس، به مستندات متریکس در اینجا مراجعه کنید.
شما میتوانید به کاربران خود یک شناسه اختصاص دهید و از این شناسه برای ارسال اعلان تکی به کاربران استفاده کنید.
یکتا نگه داشتن شناسههایی که به کاربران خود اختصاص میدهید بر عهده شماست. در صورتی که شناسهای را به بیشتر از یک کاربر اختصاص دهید، موقع ارسال اعلان به آن شناسه همه کاربرانی که آن شناسه به آنها اختصاص داده شده است اعلان را دریافت خواهند کرد.
در مواقعی ممکن است این رفتار مطلوب باشد، مثلا در صورتی که یک کاربر در چند دستگاه لاگین کرده باشد ولی در غیر این صورت توجه داشته باشید که یک شناسه را به بیش از یک کاربر اختصاص ندهید.
سه نوع شناسه قابل اختصاص دادن به کاربران وجود دارد که شما برحسب نیاز از یک یا تعدادی از آنها میتوانید استفاده کنید.
شناسه | توضیحات | نحوه اختصاص دادن |
---|---|---|
ایمیل | آدرس ایمیل کاربر | MetrixNotification.setUserEmail() |
شماره تلفن | شماره تلفن کاربر | MetrixNotification.setUserPhoneNumber() |
شناسه دلخواه | هر عبارت دلخواهی که میخواهید به عنوان شناسه استفاده کنید | MetrixNotification.setCustomId() |
با استفاده از این متد می توانید ایمیل کاربر را به عنوان یک شناسه یکتا برای وی ذخیره کنید و با استفاده از آن اعلان یکتا برای این کاربر ارسال کنید.
var userEmail = '';
MetrixNotification.setUserEmail(userEmail);
نکته: برای حذف ایمیل از قبل ذخیره شده کاربر مقدار
null
را به عنوان پارامتر به این متد بدهید.
با استفاده از این متد می توانید شماره کاربر را به عنوان شناسه یکتا برای وی دخیره کنید و با استفاده از این شماره به این کاربر اعلان یکتا ارسال کنید.
var phoneNumber = '';
MetrixNotification.setUserPhoneNumber(phoneNumber);
با استفاده از این متد می توانید یک شناسه یکتا (می توانید از هر مقداری برای شناسه یکتا استفاده کنید فقط مقدار پارامتر باید از نوع string باشد) به کاربر اختصاص دهید تا با این شناسه به کاربر اعلان یکتا ارسال کنید.
const customId = 'aCustomIdYousetForUser';
MetrixNotification.setCustomId(customId);
نکته: برای حذف شناسه از پیش ذخیره شده مقدار
null
را به عنوان پارامتر به این متد بدهید.
علاوه بر شناسههای معرفی شدهی بالا، دو شناسه دیگر به صورت خودکار به کاربران شما اختصاص داده میشود که با استفاده از آنها نیز میتوانید به کاربران خود اعلان ارسال کنید.