diff --git a/mindbox-firebase/src/main/java/cloud/mindbox/mindbox_firebase/MindboxFirebase.kt b/mindbox-firebase/src/main/java/cloud/mindbox/mindbox_firebase/MindboxFirebase.kt index 51949acb1..13c2024bc 100644 --- a/mindbox-firebase/src/main/java/cloud/mindbox/mindbox_firebase/MindboxFirebase.kt +++ b/mindbox-firebase/src/main/java/cloud/mindbox/mindbox_firebase/MindboxFirebase.kt @@ -4,7 +4,10 @@ import cloud.mindbox.mobile_sdk.logger.MindboxLogger import cloud.mindbox.mobile_sdk.pushes.MindboxPushService import cloud.mindbox.mobile_sdk.pushes.PushServiceHandler import cloud.mindbox.mobile_sdk.utils.ExceptionHandler - +/** + * An object to use when choosing push provider in Mindbox.initPushServices or Mindbox.init. + * Represents FCM + * */ object MindboxFirebase : MindboxPushService { override val tag: String = "FCM" diff --git a/mindbox-huawei/src/main/java/cloud/mindbox/mindbox_huawei/MindboxHuawei.kt b/mindbox-huawei/src/main/java/cloud/mindbox/mindbox_huawei/MindboxHuawei.kt index 7eafd81f7..87d42293c 100644 --- a/mindbox-huawei/src/main/java/cloud/mindbox/mindbox_huawei/MindboxHuawei.kt +++ b/mindbox-huawei/src/main/java/cloud/mindbox/mindbox_huawei/MindboxHuawei.kt @@ -4,7 +4,10 @@ import cloud.mindbox.mobile_sdk.logger.MindboxLogger import cloud.mindbox.mobile_sdk.pushes.MindboxPushService import cloud.mindbox.mobile_sdk.pushes.PushServiceHandler import cloud.mindbox.mobile_sdk.utils.ExceptionHandler - +/** + * An object to use when choosing push provider in Mindbox.initPushServices or Mindbox.init. + * Represents HCM + * */ object MindboxHuawei : MindboxPushService { override val tag: String = "HCM" diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/InitializeMindboxException.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/InitializeMindboxException.kt index 7a51eb9f8..f96912d9a 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/InitializeMindboxException.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/InitializeMindboxException.kt @@ -1,3 +1,5 @@ package cloud.mindbox.mobile_sdk - +/** + * An error thrown during initialization in case validation of initialization fails + * */ class InitializeMindboxException(message: String) : Exception(message) \ No newline at end of file diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/abtests/CustomerAbMixer.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/abtests/CustomerAbMixer.kt index 07750411e..efd26a7e3 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/abtests/CustomerAbMixer.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/abtests/CustomerAbMixer.kt @@ -1,5 +1,5 @@ package cloud.mindbox.mobile_sdk.abtests -interface CustomerAbMixer { +internal interface CustomerAbMixer { fun stringModulusHash(identifier: String, salt: String): Int } diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/di/Modules.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/di/Modules.kt deleted file mode 100644 index e69de29bb..000000000 diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/logger/MindboxLoggerImpl.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/logger/MindboxLoggerImpl.kt index a8c2bdf6c..10423341b 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/logger/MindboxLoggerImpl.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/logger/MindboxLoggerImpl.kt @@ -8,7 +8,9 @@ import cloud.mindbox.mobile_sdk.monitoring.domain.interfaces.MonitoringRepositor import com.android.volley.VolleyLog import kotlinx.coroutines.* import org.threeten.bp.Instant - +/** + * An interface for internal sdk work only. Do not implement or use it. + * */ interface MindboxLogger { fun i(parent: Any, message: String) diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxError.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxError.kt index 5dfef84f2..c1afb12b0 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxError.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxError.kt @@ -2,7 +2,10 @@ package cloud.mindbox.mobile_sdk.models import com.google.gson.Gson import com.google.gson.annotations.JsonAdapter - +/** + * A class for representing Mindbox error. + * Used in operations. + * */ sealed class MindboxError(open val statusCode: Int?) { companion object { diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxErrorAdapter.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxErrorAdapter.kt index 7bc066206..b17bfe0ab 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxErrorAdapter.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/MindboxErrorAdapter.kt @@ -8,7 +8,7 @@ import com.google.gson.stream.JsonReader import com.google.gson.stream.JsonToken import com.google.gson.stream.JsonWriter -class MindboxErrorAdapter : TypeAdapter() { +internal class MindboxErrorAdapter : TypeAdapter() { private val gson by lazy { Gson() } diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/ValidationMessage.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/ValidationMessage.kt index 20689bd19..e068feace 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/ValidationMessage.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/models/ValidationMessage.kt @@ -1,7 +1,9 @@ package cloud.mindbox.mobile_sdk.models import com.google.gson.annotations.SerializedName - +/** + * A class to hold validation message if validation error occurs + * */ data class ValidationMessage( @SerializedName("message") val message: String? = null, @SerializedName("location") val location: String? = null, diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/MindboxPushService.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/MindboxPushService.kt index d4894a142..5b2694eaf 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/MindboxPushService.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/MindboxPushService.kt @@ -2,7 +2,9 @@ package cloud.mindbox.mobile_sdk.pushes import cloud.mindbox.mobile_sdk.logger.MindboxLogger import cloud.mindbox.mobile_sdk.utils.ExceptionHandler - +/** + * An interface for internal sdk work only. Do not implement it + * */ interface MindboxPushService { val tag: String diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushAction.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushAction.kt index cc8db1a08..31a7b6231 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushAction.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushAction.kt @@ -1,7 +1,11 @@ package cloud.mindbox.mobile_sdk.pushes import com.google.gson.annotations.SerializedName - +/** + * A class representing mindbox push action in [RemoteMessage] + * * You can use it as a model to store data from mindbox + * * with your custom push notification implementation. + * */ data class PushAction( @SerializedName("uniqueKey") val uniqueKey: String?, @SerializedName("text") val text: String?, diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushServiceHandler.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushServiceHandler.kt index 13d62ca25..39ce43d89 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushServiceHandler.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/PushServiceHandler.kt @@ -4,7 +4,9 @@ import android.content.Context import cloud.mindbox.mobile_sdk.logger.MindboxLoggerImpl import cloud.mindbox.mobile_sdk.utils.LoggingExceptionHandler import java.util.UUID - +/** +* A class for internal sdk work only. Do not extend or use it +* */ abstract class PushServiceHandler { companion object { diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/RemoteMessage.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/RemoteMessage.kt index 696bda175..73381905c 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/RemoteMessage.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/pushes/RemoteMessage.kt @@ -1,5 +1,9 @@ package cloud.mindbox.mobile_sdk.pushes - +/** + * A class representing mindbox remote message + * You can use it as a model to store data from mindbox + * with your custom push notification implementation. + * */ data class RemoteMessage( val uniqueKey: String, val title: String, diff --git a/sdk/src/main/java/cloud/mindbox/mobile_sdk/utils/ExceptionHandler.kt b/sdk/src/main/java/cloud/mindbox/mobile_sdk/utils/ExceptionHandler.kt index 6ecc240f4..071a582c4 100644 --- a/sdk/src/main/java/cloud/mindbox/mobile_sdk/utils/ExceptionHandler.kt +++ b/sdk/src/main/java/cloud/mindbox/mobile_sdk/utils/ExceptionHandler.kt @@ -1,5 +1,7 @@ package cloud.mindbox.mobile_sdk.utils - +/** + * A class for internal sdk work only. Do not extend or use it + * */ abstract class ExceptionHandler { fun runCatching(block: () -> T) {