شناسه‌ها و توکن‌ها

v2.0.0

شناسه‌ها در پوشه

برای مشاهده‌ی توضیحات مربوط به تمام شناسه‌ها به بخش شناسه‌ها مراجعه کنید

اختصاص شناسه سفارشی به کاربران

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

یکتا نگه داشتن شناسه‌هایی که به کاربران خود اختصاص می‌دهید بر عهده شماست. در صورتی که شناسه‌ای را به بیشتر از یک کاربر اختصاص دهید، موقع ارسال اعلان به آن شناسه همه کاربرانی که آن شناسه به آن‌ها اختصاص داده شده است اعلان را دریافت خواهند کرد.
در مواقعی ممکن است این رفتار مطلوب باشد، مثلا در صورتی که یک کاربر در چند دستگاه لاگین کرده باشد ولی در غیر این صورت توجه داشته باشید که یک شناسه را به بیش از یک کاربر اختصاص ندهید.

حذف‌شدن PusheId:

زین‌پس، به جای PusheId می‌توانید از DeviceId و AdvertisingId و نیز CustomId استفاده کنید.

سه نوع شناسه قابل اختصاص دادن به کاربران وجود دارد که شما برحسب نیاز از یک یا تعدادی از آن‌ها می‌توانید استفاده کنید.

شناسه	توضیحات	نحوه اختصاص دادن
ایمیل	آدرس ایمیل کاربر	‌Pushe.setUserEmail()
شماره تلفن	شماره تلفن کاربر	‌Pushe.setUserPhoneNumber()
شناسه دلخواه	هر عبارت دلخواهی که می‌خواهید به عنوان شناسه استفاده کنید	‍Pushe.setCustomId()

متد Pushe.setUserEmail

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

var userEmail = "";
Pushe.setUserEmail(userEmail);

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

متد Pushe.setUserPhoneNumber

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

var phoneNumber = "";
Pushe.setUserPhoneNumber(phoneNumber);

متد Pushe.setCustomId

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

const customId = "aCustomIdYousetForUser";

Pushe.setCustomId(customId);

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

دریافت شناسه یکتا کاربر

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

توضیحات این شناسه‌ها در جدول زیر آمده است:

شناسه	توضیحات	نحوه دریافت
Android ID	این شناسه توسط اندروید به کاربران اختصاص داده می‌شود. در گوشی‌های با سیستم عامل پایین‌تر از اندروید ۸، شناسه‌ی Android ID کاربر بین تمامی اپلیکیشن‌های نصب شده بر روی گوشی ثابت است و همچنین پس از حذف و نصب مجدد اپلیکیشن نیز ثابت می‌ماند. در نسخه‌ی اندروید ۸ به بالا، شناسه‌ی Android ID یک کاربر تنها برای اپلیکیشن‌هایی که با کلید‌های یکسان امضا شده باشند یکتا است و برای بقیه‌ی اپلیکیشن‌ها متفاوت است.	‌Pushe.getDeviceId
Advertising ID	این شناسه برای یکتاسازی دیوایس حتی در حالتی که برنامه‌ی شما حذف یا کلیردیتا شود استفاده می‌شود. این شناسه برای ماژول FCM برابر Google Ad id خواهد بود و برای ماژول HMS برابر Huawei OAID می‌باشد. کاربر می‌تواند این شناسه را حذف یا غیرفعال نماید	‌Pushe.getAdvertisingId

// Android ID
var androidId = Pushe.getDeviceId();

// Advertising ID
var adId = Pushe.getAdvertisingId();

دریافت مقدار شناسه‌های سفارشی

برای دریافت مقادیر شناسه های سفارشی شده که متدهای آن در بالا توضیح داده شد می توانید از متد‌های زیر استفاده کنید. توضیحات این شناسه‌ها در جدول زیر آمده است:

شناسه	توضیحات	نحوه دریافت
شناسه سفارشی UserEmail	شناسه سفارشی ایمیل که توسط شما از قبل ذخیره شده توسط این متد قابل دریافت می‌باشد.	Pushe.getUserEmail
شناسه سفارشی UserPhoneNumber	شناسه سفارشی شماره کاربر که از قبل توسط شما ذخیره شده و توسط این متد قابل دریافت می‌باشد.	Pushe.getUserPhoneNumber
شناسه سفارشی CustomId	شناسه customId که از قبل توسط شما ذخیره شده و توسط این متد قابل دریافت می‌باشد.	Pushe.getCustomId

متد Pushe.getUserEmail

این متد مقداری که برای email از قبل توسط Pushe.setUserEmail ذخیره شده را برمی‌گرداند. در صورتی که هیچ مقدار ایمیلی از قبل برای آن ذخیره نشده باشد یک string خالی برمی‌گرداند.

var email =  Pushe.getUserEmail();

متد Pushe.getUserPhoneNumber

این متد مقداری که برای phoneNumber از قبل توسط Pushe.setUserPhoneNumber ذخیره شده را برمی‌گرداند. در صورتی که هیچ مقداری از قبل ذخیره نشده باشد یک string خالی بر‌می‌گرداند.

var phone =  Pushe.getUserPhoneNumber();

متد Pushe.getCustomId

این متد مقداری که از قبل برای customId توسط Pushe.setCustomId ذخیره شده را بر‌می‌گرداند. در صورتی که هیچ مقداری از قبل ذخیره نشده باشد یک string خالی برمی‌گرداند.

var customId =  Pushe.getCustomId();

توکن‌های اختصاصی سرویس‌های فایربیس و هواوی

بدست‌آوردن Fcm Token و HMS Token

در صورتی که بخواهید از توکن مستقیم Firebase cloud messaging و یا Huawei PushKit استفاده کنید می‌توانید با استفاده از توابع زیر آنها را بدست آورید:

Fcm

val cachedToken = Pushe.getPusheService(PusheFCM::class)?.getToken()
Pushe.getPusheService(PusheFCM::class)?.getToken { token ->
   // Use token
}

HMS

مطمئن شوید ماژول hms اضافه شده باشد. اطلاعات بیشتر

val cachedToken = Pushe.getPusheService(PusheHMS::class)?.getToken()
Pushe.getPusheService(PusheHMS::class)?.getToken { token ->
   // Use token
}