Cordova

راه‌اندازی

اضافه کردن پلاگین

دقت کنید در صورتی که قبلا پلاگین را به صورت فایل دانلود و نصب کرده بودید قبل از نصب این نسخه حتما پلاگین قبلی را از پروژه خود پاک کنید.

با استفاده از دستور زیر پلاگین پوش‌پل برای کوردوا را به اپلیکیشن خود اضافه کنید.

cordova plugin add pushpole-cordova

تغییرات plugin.xml

وارد کنسول پوش‌پل شوید و در قسمت اپلیکیشن ها، روی آیکون دریافت منیفست بزنید (این آیکون را با کلیک بر روی علامت سه نقطه ی گوشه ی کارت اپلیکیشن می توانید ببینید).

کد منیفست اپلیکیشن‌تان را که مشابه کد زیر می‌باشد کپی کرده و در فایل config.xml که در روت پروژه کوردوا می باشد در زیر مجموعه تگ <platform name="android"></platform> قرار دهید.

<config-file parent="application" target="AndroidManifest.xml">
    <meta-data android:name="com.pushpole.sdk.token" android:value="PUSHPOLE_TOKEN" />
</config-file>

در صورتی که مشککد زیر را هم به تگ ابتدایی widget در فایل config.xml اضافه کنید.

xmlns:android="http://schemas.android.com/apk/res/android"

راه اندازی پوش‌پل

• فایل index.js را از آدرس www/js/index.js باز کرده و در داخل متد ‍‍receivedEvent کد زیر را قرار دهید:

window.pushpole.initialize();

تست

پس از اینکه فایل کتابخانه را مطابق با آموزش داده شده نصب کردید، میتوانید پروژه را اجرا و بر روی دستگاه خود نصب و تست کنید.

• به صفحه نصب ها بروید.
• بعد از گذشت زمان کوتاهی یک ردیف مشخصات نصب به لیست نصب ها اضافه می شود که متعلق به گوشی شما است.
• یک اعلان تست ارسال کنید.دقت کنید تلفن همراه شما به اینترنت متصل باشد.

توصیه می شود اپلیکیشن را بر روی موبایل یا تبلت اجرا و تست کنید. اگر می خواهید اپلیکیشن را بر روی Emulator تست کنید، بر روی ایمولاتور شما باید Google API نصب باشد.

امکانات

PushPoleId

این شناسه برای یکتاسازی دستگاه‌هایی که پوش‌پل در آن‌ها رجیسترشده استفاده‌می‌شود. برای گرفتن شناسه‌ی پوش‌پل دستگاهی که برنامه در آن نصب شده از کد زیر استفاده کنید.

window.pushpole.getId(function pidCallnack(pid){
    console.log("PushPoleID is: " + pid);
});

دریافت اطلاعات دلخواه با فرمت JSON

شما میتوانید از طریق پنل برای اپلیکیشن خود اطلاعات دلخواه در قالب یک JSON ارسال کنید. برای اینکه بتوانید از این اطلاعات در اپلیکیشن خود استفاده کنید کافیست که

 window.pushpole.jsonCallback()

را با یک تابع کال بک به عنوان ورودی صدا کنید. فرض کنید جیسونی به صورت مقابل فرستاده اید:

{
    "titr": "تیتر",
    "matn": "متن"
}

با گذاشتن کد زیر در فایل js ای که برای صدا زدن تابع initialize پوش‌پل در نظر گرفته اید، می توانید جیسون را دریافت کنید.

window.pushpole.jsonCallback(function userCallback(jsonMsg){
    console.log("user jsonMsg is : " + JSON.stringify(jsonMsg));
    //process your json message
});

تاپیک (topic)

شما می توانید کاربران خود را در تاپیک یا کانال های متفاوت ثبت نام کنید و برحسب علاقمندی کاربران یا دسته بندی خودتان به تاپیک مرتبط پوش بفرستید. مثلا اگر شما اپلیکیشن خبری دارید و کاربرانی به اخبار ورزشی علاقمند هستند و عده ای به اخبار فرهنگی، می توانید دسته اول را در تاپیک ورزشی و دسته دوم را درتاپیک فرهنگی ثبت نام کنید و هنگام ارسال پوش، برحسب محتوای پوشتان به تاپیک مرتبط آن را ارسال کنید تا فقط کاربران علاقمند به آن موضوع آن را دریافت کنند.

برای استفاده از این امکان باید کاربران خود را در تاپیک مورد نظر عضو کنید. فرض کنید نام تاپیک مورد نظرتان varzeshi باشد. برای عضویت در این تاپیک از اسکریپت زیر استفاده کنید:

window.pushpole.subscribe("varzeshi");

برای لغو عضویت از این تاپیک از اسکریپت زیر استفاده کنید:

window.pushpole.unsubscribe("varzeshi");

دو اسکریپت فوق را در محل مناسب و بر روی event مناسب قرار دهید (مثلا کلیک یک دکمه).

نکته: توجه داشته باشید که توابع مربوط به عضو شدن و لغو عضویت در تاپیک باید بعد از پایان PushPole.initialize اجرا شوند. بنابراین آنها را بلافاصله بعد از window.pushpole.initialize قرار ندهید.

window.pushpole.isPushPoleInitialized(function pushpoleInited(result){
       if(result) {
            window.pushpole.sendAdvancedNotifToUser("pid_a0e3-82ac-a0", "{ \"title\":\"test\", \"content\":\"sent from client\" }");
       }
 });

غیرفعال کردن نمایش پوش

می توانید نمایش پوش را غیرفعال کنید. مثلا در تنظیمات اپلیکیشن خود امکان دریافت نکردن پوش را برای کاربر قرار دهید و طبق انتخاب کاربر آن را فعال یا غیرفعال کنید.

برای غیرفعال کردن نمایش پوش از اسکریپت زیر در محل مناسب استفاده کنید:

window.pushpole.setNotificationOff();

برای فعال سازی دوباره ی نمایش پوش از اسکریپت زیر بر روی event مناسب استفاده کنید:

window.pushpole.setNotificationOn();

ارسال پوش از یک دستگاه به دستگاه دیگر

می توانید مستقیم از یک دستگاه به دستگاه دیگر اعلان بفرستید. برای این کار باید شناسه ی پوش‌پل ی آن دستگاه یعنی pushpoleId آن را داشته باشید. برای بدست آوردن شناسه هر دستگاه می توانید به روش زیر عمل کنید:

window.pushpole.getId(function pidCallnack(pid){
    console.log("pid is: " + pid);
});

به این روش pid هر دستگاه را می توانید بدست بیاورید و آنها را در سرور خود ذخیره کنید تا برای ارسال اعلان به دستگاه از آن استفاده کنید. برای ارسال اعلان ساده از دستور زیر استفاده کنید:

window.pushpole.sendSimpleNotifToUser("pid_a0e3-82ac-a0", "title", "content");

پارامتر اول pushpoleId است و پارامتر دوم و سوم به ترتیب تیتر و متن اعلان هستند.

برای ارسال اعلان پیشرفته از این دستور استفاده کنید:

window.pushpole.sendAdvancedNotifToUser("pid_a0e3-82ac-a0", "{ \"title\":\"تست\", \"content\":\"پیام ارسالی از یک دستگاه \" }");

پارامتر اول pushpoleId است و پارامتر دوم یک رشته با فرمت جیسون است که مشخصات اعلان پیشرفته را تعیین می کند. برای دیدن فرمت جیسون اعلان پیشرفته به قسمت راهنمای استفاده از API قسمت ارسال اعلان پیشرفته مراجعه کنید. برای ارسال جیسون دلخواه از دستور زیر استفاده کنید:

window.pushpole.sendCustomJsonToUser("pid_a0e3-82ac-a0", "{ \"key1\":\"value1\", \"key2\":\"value2\" }");

در این حالت پارامتر دوم یک رشته با فرمت جیسون هست که اطلاعاتی که می خواهید ارسال کنید را به فرمت جیسون داخلش دارد.

نکته مهم: توابع ارسال اعلان به دستگاه دیگر و عضویت یا لغو عضویت در تاپیک را بعد از اطمینان از اینکه عملیات initialization پوش‌پل انجام شده است، صدا بزنید. برای این کار به روش زیر عمل کنید:

window.pushpole.isPushPoleInitialized(function pushpoleInited(result){
       if(result) {
            window.pushpole.sendAdvancedNotifToUser("pid_a0e3-82ac-a0", "{ \"title\":\"test\", \"content\":\"sent from client\" }");
       }
 });

ایجاد و حذف کانال نوتیفیکیشن در اپلیکیشن (Android 8.0+ only)

در اندروید ۸ به بعد قابلیتی برای تعریف کانال نوتیفیکیشن در اپلیکیشن ایجاد شده است. به این شکل که در برنامه خود یک یا چند کانال نوتیفیکیشن تعریف می کنید و در زمان ارسال اعلان پیشرفته با وارد کردن Channel-Id آن کانال می توانید اعلان را برای آن کانال خاص ارسال کنید. مزیت این کار این هست که کاربر می تواند دریافت نوتیفیکیشن از بعضی کانال ها را غیرفعال کند و همچنان بتواند از یک یا چند کانال دیگر اعلان بگیرد. فراخوانی تابع ایجاد یا حذف کانال در حالتی که برنامه شما روی اندروید زیر ۸ اجرا شود، اثری ندارد. همچنین اگر بیشتر از یکبار تابع ایجاد کانال را صدا بزنید هم فقط یکبار کانال ایجاد می شود و مشکلی ایجاد نمی کند.

با استفاده از دستور زیر در برنامه خود می توانید کانال نوتیفیکشن تعریف کنید:

window.pushpole.createNotificationChannel(
            "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
            -16776961, //led color
);

با استفاده از تابع زیر در برنامه خود می توانید کانال نوتیفیکشنی که قبلا ایجاد کردید را حذف کنید:

window.pushpole.removeNotificationChannel(
            "MY_CHANNEL_ID" //channelId
);