پیش‌فرض این صفحه، این است که شما تمامی مراحل پیش‌نیازها را طی کرده‌اید.
افزودن کتابخانه
کتابخانه چابک از طریق mavenCentral در دسترس است. برای این منظور ابتدا در فایل gradle اصلی پروژه، mavenCentral را بعنوان repository مطابق قطعه کد زیر اضافه نمایید:
buildscript {
repositories {
mavenCentral()
}
}
مدل نسخه‌گذاری در چابک (Semantic Versioning)
چابک از مدل نسخه‌گذاری MAJOR.MINOR.PATCH استفاده می‌کند. همه تغییرات نسخه‌ها بلافاصله پس از انتشارشان به صورت موردی در صفحه لیست تغییرات برای اطلاع شما اضافه می‌شوند. برای همین توصیه می‌کنیم این صفحه را حتما مطالعه نمایید. این موارد برای هر نسخه در دو بخش ارتقا و تغییرات برای شما نمایش داده شده است.
Patch:تغییرات در این سطح شامل Bug Fix و قابلیت‌های بسیار کوچک می‌باشد. به روز رسانی به این نسخه‌ها نیاز به تغییری در کد ندارد. برای آگاهی از آن‌ها، باید بخش تغییرات را مطالعه کنید. به عنوان مثال به روز رسانی کتابخانه چابک از نسخه2.13.0به نسخه2.13.2مربوط به این سطح می‌شود.Minor:تغییرات در این سطح شامل قابلیت‌های بزرگتر و تغییر در کارکرد (Functionality) کتابخانه می‌شود. در به روز رسانی به این نسخه‌ها حتما باید بخش ارتقا و تغییرات صفحه لیست تغییرات را با دقت مطالعه کنید. در صورت بروز هر گونه مشکل در نتیجه رعایت نکردن نکات بخش ارتقا و تغییرات در به روز رسانی به نسخه‌های Minor، تیم چابک مسئولیتی را نمی‌پذیرد. توصیه می‌کنیم که هر سه تا شش ماه اقدام به بررسی نسخه‌های Minor نمایید. به عنوان مثال به روز رسانی کتابخانه چابک از نسخه2.12.1به نسخه2.13.2مربوط به این سطح می‌شود.Major:این سطح از تغییرات مخصوص بازنویسی و یا تغییرات اساسی در کتابخانه چابک است. در به روز رسانی به این نسخه‌ها حتما باید بخش ارتقا و تغییرات تغییرات صفحه لیست تغییرات را با دقت مطالعه کنید. در صورت بروز هر گونه مشکل در نتیجه رعایت نکردن نکات بخش ارتقا و تغییرات در به روز رسانی به نسخه‌های Major، تیم چابک مسئولیتی را نمی‌پذیرد. بنابراین توصیه می‌کنیم که هر یک سال اقدام به بررسی نسخه‌های Major نمایید. به عنوان مثال به‌روزرسانی کتابخانه چابک از نسخه1.0.1به نسخه2.13.2مربوط به این سطح می‌شود.
نکته:در مدلPatchشما می‌توانید از کاراکتر + (Wildcard) استفاده کنید و به آسانی از تغییرات آن بهره‌مند شوید.
نصب کتابخانه
چابک دارای دو کتابخانه استاندارد و با قابلیت مکان‌یابی می‌باشد. شما می‌توانید متناسب با نیاز خودتان از یکی آن‌ها استفاده کنید.
نصب کتابخانه استاندارد چابک
برای استفاده از کتابخانه چابک بدون نیاز به قابلیت مکان‌یابی (استاندارد) از کتابخانه chabok-lib که در زیر به آن اشاره‌شده است، استفاده کنید. فایل build.gradle در مسیر app را باز کرده و در بخش dependencies خط زیر را اضافه نمایید:
dependencies {
compile 'me.leolin:ShortcutBadger:1.1.22@aar'
compile 'com.adpdigital.push:chabok-lib:VERSION'
}
نکته:توجه داشته باشید که برایVERSIONآخرین نسخه کتابخانه را از این صفحه مشاهده کنید و سپس آن را وارد نمایید.
نکته:دقت داشته باشید که همیشه از جدیدترین نسخه ShortcutBadger استفاده کنید. برای اطلاع از آخرین نسخه می‌توانید به این لینک مراجعه نمایید. همچنین با توجه به حجم زیاد مجوزهای نمایش نشان (Badge) روی آیکون اپ، می‌توانید از این قسمت هر کدام از آن‌ها را با اختیار خودتان بردارید.
آخرین نسخه فایل کتابخانه چابک از اینجا قابل دسترس می‌باشد. در انتها گزینه سینک را بزنید.
| buildTools | compileSdk | targetSdk | googlePlayServices |
|---|---|---|---|
| 25.x.x | 25 | >= 23 | >= 9.6.0 |
| 26.x.x | 26 | >= 23 | >= 9.6.0 |
| 27.x.x | 27 | >= 23 | >= 10.2.1 |
نکته :به علت محدودیت‌‌های اندروید ۸ به بالا دقت کنید حتما مطابق جدول زیر تنظیمات نسخه‌ها را بدرستی انجام دهید. در صورت رعایت نکردن نسخه‌های ذکر شده در جدول زیر هنگامی که اپلیکیشن kill شده باشد به هنگام دریافت نوتیفیکیشن با خطا مواجه خواهد شد.
نکته: برای استفاده از سرویس جی‌سی‌ام گوگل لازم است خط زیر نیز در بخشdependenciesاضافه شود:
dependencies {
compile "com.google.android.gms:play-services-gcm:10.2.6"
}
نصب کتابخانه با قابلیت مکان‌یابی چابک
درصورتی که در برنامه خود نیاز به استفاده از موقعیت مکانی کاربر دارید، لازم است در ابتدا کتابخانه chabok-lib را حذف و کتابخانه chabok-lib-geo را جایگزین کنید. باتوجه به اینکه در این کتابخانه از سرویس فیوز گوگل استفاده شده است باید تغییرات زیر نیز در قسمت dependencies اعمال شود:
dependencies {
compile 'com.google.android.gms:play-services-location:10.2.6'
compile 'com.adpdigital.push:chabok-lib-geo:VERSION'
compile 'me.leolin:ShortcutBadger:1.1.22@aar'
}
