Skip to content

Commit 151a7f9

Browse files
jennantillajennantilla
committed
Update notifications module property naming
address linting error that enforces camel case and screaming snake case
1 parent 56948ba commit 151a7f9

File tree

19 files changed

+135
-113
lines changed

19 files changed

+135
-113
lines changed

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/NotificationsManager.kt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ internal class NotificationsManager(
5050
override val canRequestPermission: Boolean
5151
get() = _notificationPermissionController.canRequestPermission
5252

53-
private val _permissionChangedNotifier = EventProducer<IPermissionObserver>()
53+
private val permissionChangedNotifier = EventProducer<IPermissionObserver>()
5454

5555
init {
5656
_applicationService.addApplicationLifecycleHandler(this)
@@ -100,7 +100,7 @@ internal class NotificationsManager(
100100

101101
if (oldPermissionStatus != isEnabled) {
102102
// switch over to the main thread for the firing of the event
103-
_permissionChangedNotifier.fireOnMain { it.onNotificationPermissionChange(isEnabled) }
103+
permissionChangedNotifier.fireOnMain { it.onNotificationPermissionChange(isEnabled) }
104104
}
105105
}
106106

@@ -132,12 +132,12 @@ internal class NotificationsManager(
132132

133133
override fun addPermissionObserver(observer: IPermissionObserver) {
134134
Logging.debug("NotificationsManager.addPermissionObserver(observer: $observer)")
135-
_permissionChangedNotifier.subscribe(observer)
135+
permissionChangedNotifier.subscribe(observer)
136136
}
137137

138138
override fun removePermissionObserver(observer: IPermissionObserver) {
139139
Logging.debug("NotificationsManager.removePermissionObserver(observer: $observer)")
140-
_permissionChangedNotifier.unsubscribe(observer)
140+
permissionChangedNotifier.unsubscribe(observer)
141141
}
142142

143143
override fun addForegroundLifecycleListener(listener: INotificationLifecycleListener) {

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/analytics/impl/FirebaseAnalyticsTracker.kt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ internal class FirebaseAnalyticsTracker(
6565
if (lastOpenedTime != null && now - lastOpenedTime!!.get() < 1000 * 30) return
6666
try {
6767
val firebaseAnalyticsInstance = getFirebaseAnalyticsInstance()
68-
val trackMethod = getTrackMethod(FirebaseAnalyticsClass)
68+
val trackMethod = getTrackMethod(firebaseAnalyticsClass)
6969
val event = EVENT_NOTIFICATION_INFLUENCE_OPEN
7070

7171
// construct the firebase analytics event bundle
@@ -96,7 +96,7 @@ internal class FirebaseAnalyticsTracker(
9696
try {
9797
// get the source, medium, campaign params from the openResult
9898
val firebaseAnalyticsInstance = getFirebaseAnalyticsInstance()
99-
val trackMethod = getTrackMethod(FirebaseAnalyticsClass)
99+
val trackMethod = getTrackMethod(firebaseAnalyticsClass)
100100

101101
// construct the firebase analytics event bundle
102102
val bundle = Bundle()
@@ -121,7 +121,7 @@ internal class FirebaseAnalyticsTracker(
121121
try {
122122
// get the source, medium, campaign params from the openResult
123123
val firebaseAnalyticsInstance = getFirebaseAnalyticsInstance()
124-
val trackMethod = getTrackMethod(FirebaseAnalyticsClass)
124+
val trackMethod = getTrackMethod(firebaseAnalyticsClass)
125125
// construct the firebase analytics event bundle
126126
val bundle = Bundle()
127127
bundle.putString("source", "OneSignal")
@@ -140,7 +140,7 @@ internal class FirebaseAnalyticsTracker(
140140

141141
private fun getFirebaseAnalyticsInstance(): Any? {
142142
if (mFirebaseAnalyticsInstance == null) {
143-
val getInstanceMethod = getInstanceMethod(FirebaseAnalyticsClass)
143+
val getInstanceMethod = getInstanceMethod(firebaseAnalyticsClass)
144144
mFirebaseAnalyticsInstance =
145145
try {
146146
getInstanceMethod!!.invoke(null, _applicationService.appContext)
@@ -153,14 +153,14 @@ internal class FirebaseAnalyticsTracker(
153153
}
154154

155155
companion object {
156-
private var FirebaseAnalyticsClass: Class<*>? = null
156+
private var firebaseAnalyticsClass: Class<*>? = null
157157
private const val EVENT_NOTIFICATION_OPENED = "os_notification_opened"
158158
private const val EVENT_NOTIFICATION_INFLUENCE_OPEN = "os_notification_influence_open"
159159
private const val EVENT_NOTIFICATION_RECEIVED = "os_notification_received"
160160

161161
fun canTrack(): Boolean {
162162
return try {
163-
FirebaseAnalyticsClass =
163+
firebaseAnalyticsClass =
164164
Class.forName("com.google.firebase.analytics.FirebaseAnalytics")
165165
true
166166
} catch (e: ClassNotFoundException) {

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/channels/impl/NotificationChannelManager.kt‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -80,29 +80,29 @@ internal class NotificationChannelManager(
8080
} else {
8181
objChannelPayload as JSONObject
8282
}
83-
var channel_id = channelPayload!!.optString("id", DEFAULT_CHANNEL_ID)
83+
var channelId = channelPayload!!.optString("id", DEFAULT_CHANNEL_ID)
8484
// Ensure we don't try to use the system reserved id
85-
if (channel_id == NotificationChannel.DEFAULT_CHANNEL_ID) channel_id = DEFAULT_CHANNEL_ID
85+
if (channelId == NotificationChannel.DEFAULT_CHANNEL_ID) channelId = DEFAULT_CHANNEL_ID
8686
var payloadWithText = channelPayload
8787
if (channelPayload.has("langs")) {
8888
val langList = channelPayload.getJSONObject("langs")
8989
val language = _languageContext.language
9090
if (langList.has(language)) payloadWithText = langList.optJSONObject(language)
9191
}
92-
val channel_name = payloadWithText!!.optString("nm", "Miscellaneous")
92+
val channelName = payloadWithText!!.optString("nm", "Miscellaneous")
9393
val importance = priorityToImportance(payload.optInt("pri", 6))
94-
val channel = NotificationChannel(channel_id, channel_name, importance)
94+
val channel = NotificationChannel(channelId, channelName, importance)
9595
channel.description = payloadWithText.optString("dscr", null)
9696
if (channelPayload.has("grp_id")) {
97-
val group_id = channelPayload.optString("grp_id")
98-
val group_name: CharSequence = payloadWithText.optString("grp_nm")
97+
val groupId = channelPayload.optString("grp_id")
98+
val groupName: CharSequence = payloadWithText.optString("grp_nm")
9999
notificationManager.createNotificationChannelGroup(
100100
NotificationChannelGroup(
101-
group_id,
102-
group_name,
101+
groupId,
102+
groupName,
103103
),
104104
)
105-
channel.group = group_id
105+
channel.group = groupId
106106
}
107107
if (payload.has("ledc")) {
108108
var ledc = payload.optString("ledc")
@@ -156,7 +156,7 @@ internal class NotificationChannelManager(
156156
// https://github.com/OneSignal/OneSignal-Android-SDK/issues/895
157157
e.printStackTrace()
158158
}
159-
return channel_id
159+
return channelId
160160
}
161161

162162
@RequiresApi(api = Build.VERSION_CODES.O)

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/common/NotificationHelper.kt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ import org.json.JSONObject
2222
import kotlin.math.min
2323

2424
object NotificationHelper {
25-
const val grouplessSummaryKey = "os_group_undefined"
26-
const val grouplessSummaryId = -718463522
25+
const val GROUPLESS_SUMMARY_KEY = "os_group_undefined"
26+
const val GROUPLESS_SUMMARY_ID = -718463522
2727

2828
/**
2929
* Getter for obtaining all active notifications
@@ -52,7 +52,7 @@ object NotificationHelper {
5252
var groupCount = 0
5353
for (statusBarNotification in statusBarNotifications) {
5454
if (!NotificationCompat.isGroupSummary(statusBarNotification.notification) &&
55-
grouplessSummaryKey == statusBarNotification.notification.group
55+
GROUPLESS_SUMMARY_KEY == statusBarNotification.notification.group
5656
) {
5757
groupCount++
5858
}
@@ -78,7 +78,7 @@ object NotificationHelper {
7878
val isGroupSummary = isGroupSummary(statusBarNotification)
7979
val isGroupless = (
8080
notification.group == null ||
81-
notification.group == grouplessSummaryKey
81+
notification.group == GROUPLESS_SUMMARY_KEY
8282
)
8383
if (!isGroupSummary && isGroupless) {
8484
grouplessStatusBarNotifications.add(
@@ -109,7 +109,7 @@ object NotificationHelper {
109109
// Recreate the notification but with the groupless key instead
110110
val notif =
111111
grouplessNotifBuilder
112-
.setGroup(grouplessSummaryKey)
112+
.setGroup(GROUPLESS_SUMMARY_KEY)
113113
.setOnlyAlertOnce(true)
114114
.build()
115115
NotificationManagerCompat.from(context!!).notify(grouplessNotif.id, notif)

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/data/impl/NotificationRepository.kt‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,8 @@ internal class NotificationRepository(
166166
_databaseProvider.os.query(
167167
OneSignalDbContract.NotificationTable.TABLE_NAME,
168168
columns = retColumn,
169-
whereClause = OneSignalDbContract.NotificationTable.COLUMN_NAME_NOTIFICATION_ID + " = ?", // Where String
169+
// Where String
170+
whereClause = OneSignalDbContract.NotificationTable.COLUMN_NAME_NOTIFICATION_ID + " = ?",
170171
whereArgs = whereArgs,
171172
) {
172173
val exists = it.moveToFirst()
@@ -305,7 +306,7 @@ internal class NotificationRepository(
305306
var whereStr: String
306307
var whereArgs: Array<String>? = null
307308
if (summaryGroup != null) {
308-
val isGroupless = summaryGroup == NotificationHelper.grouplessSummaryKey
309+
val isGroupless = summaryGroup == NotificationHelper.GROUPLESS_SUMMARY_KEY
309310
if (isGroupless) {
310311
whereStr =
311312
OneSignalDbContract.NotificationTable.COLUMN_NAME_GROUP_ID + " IS NULL"
@@ -360,7 +361,8 @@ internal class NotificationRepository(
360361
withContext(Dispatchers.IO) {
361362
_databaseProvider.os.query(
362363
OneSignalDbContract.NotificationTable.TABLE_NAME,
363-
columns = arrayOf(OneSignalDbContract.NotificationTable.COLUMN_NAME_GROUP_ID), // retColumn
364+
// retColumn
365+
columns = arrayOf(OneSignalDbContract.NotificationTable.COLUMN_NAME_GROUP_ID),
364366
whereClause = OneSignalDbContract.NotificationTable.COLUMN_NAME_ANDROID_NOTIFICATION_ID + " = " + androidId,
365367
) {
366368
if (it.moveToFirst()) {
@@ -379,7 +381,8 @@ internal class NotificationRepository(
379381
withContext(Dispatchers.IO) {
380382
_databaseProvider.os.query(
381383
OneSignalDbContract.NotificationTable.TABLE_NAME,
382-
columns = arrayOf(OneSignalDbContract.NotificationTable.COLUMN_NAME_ANDROID_NOTIFICATION_ID), // retColumn
384+
// retColumn
385+
columns = arrayOf(OneSignalDbContract.NotificationTable.COLUMN_NAME_ANDROID_NOTIFICATION_ID),
383386
whereClause =
384387
OneSignalDbContract.NotificationTable.COLUMN_NAME_COLLAPSE_ID + " = ? AND " +
385388
OneSignalDbContract.NotificationTable.COLUMN_NAME_DISMISSED + " = 0 AND " +
@@ -407,8 +410,10 @@ internal class NotificationRepository(
407410
OneSignalDbContract.NotificationTable.TABLE_NAME,
408411
columns = arrayOf(OneSignalDbContract.NotificationTable.COLUMN_NAME_ANDROID_NOTIFICATION_ID),
409412
whereClause = _queryHelper.recentUninteractedWithNotificationsWhere().toString(),
410-
orderBy = BaseColumns._ID, // sort order, old to new
411-
limit = maxNumberOfNotificationsString + notificationsToMakeRoomFor, // limit
413+
// sort order, old to new
414+
orderBy = BaseColumns._ID,
415+
// limit
416+
limit = maxNumberOfNotificationsString + notificationsToMakeRoomFor,
412417
) {
413418
var notificationsToClear =
414419
it.count - maxNumberOfNotificationsInt + notificationsToMakeRoomFor
@@ -444,7 +449,8 @@ internal class NotificationRepository(
444449
OneSignalDbContract.NotificationTable.COLUMN_NAME_OPENED + " = 0 AND " +
445450
OneSignalDbContract.NotificationTable.COLUMN_NAME_IS_SUMMARY + " = 0",
446451
whereArgs = whereArgs,
447-
orderBy = BaseColumns._ID + " DESC", // sort order, new to old);
452+
// sort order, new to old);
453+
orderBy = BaseColumns._ID + " DESC",
448454
) {
449455
if (it.moveToFirst()) {
450456
do {
@@ -485,7 +491,7 @@ internal class NotificationRepository(
485491
getSummaryNotification: Boolean,
486492
): Int? {
487493
var recentId: Int? = null
488-
val isGroupless = group == NotificationHelper.grouplessSummaryKey
494+
val isGroupless = group == NotificationHelper.GROUPLESS_SUMMARY_KEY
489495

490496
/* Beginning of the query string changes based on being groupless or not
491497
* since the groupless notifications will have a null group key in the db */
@@ -546,8 +552,10 @@ internal class NotificationRepository(
546552
OneSignalDbContract.NotificationTable.TABLE_NAME,
547553
columns = COLUMNS_FOR_LIST_NOTIFICATIONS,
548554
whereClause = dbQuerySelection.toString(),
549-
orderBy = BaseColumns._ID + " DESC", // sort order, new to old
550-
limit = INotificationLimitManager.Constants.maxNumberOfNotifications.toString(), // limit
555+
// sort order, new to old
556+
orderBy = BaseColumns._ID + " DESC",
557+
// limit
558+
limit = INotificationLimitManager.Constants.maxNumberOfNotifications.toString(),
551559
) {
552560
while (it.moveToNext()) {
553561
val title =

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/display/impl/NotificationDisplayBuilder.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,8 +269,8 @@ internal class NotificationDisplayBuilder(
269269
} catch (t: Throwable) {
270270
}
271271
if (bitmap != null) return bitmap
272-
val image_extensions = Arrays.asList(".png", ".webp", ".jpg", ".gif", ".bmp")
273-
for (extension in image_extensions) {
272+
val imageExtensions = Arrays.asList(".png", ".webp", ".jpg", ".gif", ".bmp")
273+
for (extension in imageExtensions) {
274274
try {
275275
bitmap =
276276
BitmapFactory.decodeStream(currentContext!!.assets.open(bitmapStr + extension))

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/display/impl/NotificationDisplayer.kt‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ internal class NotificationDisplayer(
8686

8787
// If the null this makes the 4th notification and we want to check that 3 or more active groupless exist
8888
if (group == null && grouplessNotifs.size >= 3) {
89-
group = NotificationHelper.grouplessSummaryKey
89+
group = NotificationHelper.GROUPLESS_SUMMARY_KEY
9090
NotificationHelper.assignGrouplessNotifications(
9191
currentContext,
9292
grouplessNotifs,
@@ -133,7 +133,7 @@ internal class NotificationDisplayer(
133133
notification = _summaryNotificationDisplayer.createSingleNotificationBeforeSummaryBuilder(notificationJob, notifBuilder)
134134

135135
// Create PendingIntents for notifications in a groupless or defined summary
136-
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N && group == NotificationHelper.grouplessSummaryKey) {
136+
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N && group == NotificationHelper.GROUPLESS_SUMMARY_KEY) {
137137
_summaryNotificationDisplayer.createGrouplessSummaryNotification(
138138
notificationJob,
139139
intentGenerator,
@@ -245,18 +245,18 @@ internal class NotificationDisplayer(
245245
Logging.verbose("Cannot use background images in notifications for device on version: " + Build.VERSION.SDK_INT)
246246
return
247247
}
248-
var bg_image: Bitmap? = null
248+
var bgImage: Bitmap? = null
249249
var jsonBgImage: JSONObject? = null
250250
val jsonStrBgImage = fcmJson.optString("bg_img", null)
251251
if (jsonStrBgImage != null) {
252252
jsonBgImage = JSONObject(jsonStrBgImage)
253-
bg_image = getBitmap(jsonBgImage.optString("img", null))
253+
bgImage = getBitmap(jsonBgImage.optString("img", null))
254254
}
255-
if (bg_image == null) {
256-
bg_image =
255+
if (bgImage == null) {
256+
bgImage =
257257
getBitmapFromAssetsOrResourceName("onesignal_bgimage_default_image")
258258
}
259-
if (bg_image != null) {
259+
if (bgImage != null) {
260260
val customView =
261261
RemoteViews(currentContext!!.packageName, R.layout.onesignal_bgimage_notif_layout)
262262
customView.setTextViewText(R.id.os_bgimage_notif_title, _notificationDisplayBuilder.getTitle(fcmJson))
@@ -299,14 +299,14 @@ internal class NotificationDisplayer(
299299
0,
300300
0,
301301
)
302-
customView.setImageViewBitmap(R.id.os_bgimage_notif_bgimage_right_aligned, bg_image)
302+
customView.setImageViewBitmap(R.id.os_bgimage_notif_bgimage_right_aligned, bgImage)
303303
customView.setViewVisibility(
304304
R.id.os_bgimage_notif_bgimage_right_aligned,
305305
View.VISIBLE,
306306
) // visible
307307
customView.setViewVisibility(R.id.os_bgimage_notif_bgimage, View.GONE) // gone
308308
} else {
309-
customView.setImageViewBitmap(R.id.os_bgimage_notif_bgimage, bg_image)
309+
customView.setImageViewBitmap(R.id.os_bgimage_notif_bgimage, bgImage)
310310
}
311311
notifBuilder!!.setContent(customView)
312312

@@ -362,8 +362,8 @@ internal class NotificationDisplayer(
362362
} catch (t: Throwable) {
363363
}
364364
if (bitmap != null) return bitmap
365-
val image_extensions = Arrays.asList(".png", ".webp", ".jpg", ".gif", ".bmp")
366-
for (extension in image_extensions) {
365+
val imageExtensions = Arrays.asList(".png", ".webp", ".jpg", ".gif", ".bmp")
366+
for (extension in imageExtensions) {
367367
try {
368368
bitmap =
369369
BitmapFactory.decodeStream(currentContext!!.assets.open(bitmapStr + extension))

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/display/impl/SummaryNotificationDisplayer.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,9 +261,9 @@ internal class SummaryNotificationDisplayer(
261261
val fcmJson: JSONObject = notificationJob.jsonPayload!!
262262
val summaryNotification: Notification
263263
val random = SecureRandom()
264-
val group: String = NotificationHelper.grouplessSummaryKey
264+
val group: String = NotificationHelper.GROUPLESS_SUMMARY_KEY
265265
val summaryMessage = "$grouplessNotifCount new messages"
266-
val summaryNotificationId: Int = NotificationHelper.grouplessSummaryId
266+
val summaryNotificationId: Int = NotificationHelper.GROUPLESS_SUMMARY_ID
267267
_dataController.createSummaryNotification(summaryNotificationId!!, group)
268268
val summaryContentIntent: PendingIntent? =
269269
intentGenerator.getNewActionPendingIntent(

‎OneSignalSDK/onesignal/notifications/src/main/java/com/onesignal/notifications/internal/generation/impl/NotificationGenerationProcessor.kt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,8 @@ internal class NotificationGenerationProcessor(
278278
customJSON.optString("i"),
279279
jsonPayload.safeString("grp"),
280280
collapseKey,
281-
notificationJob.isNotificationToDisplay, // When notification was displayed, count any notifications with duplicated android notification ids as dismissed.
281+
// When notification was displayed, count any notifications with duplicated android notification ids as dismissed.
282+
notificationJob.isNotificationToDisplay,
282283
opened,
283284
notificationJob.androidId,
284285
if (notificationJob.title != null) notificationJob.title.toString() else null,

0 commit comments

Comments
 (0)