Files
quik/domain/src/main/java/com/moez/QKSMS/blocking/BlockingClient.kt
T
2023-11-14 13:48:22 -07:00

88 lines
2.7 KiB
Kotlin

/*
* Copyright (C) 2017 Moez Bhatti <moez.bhatti@gmail.com>
*
* This file is part of QKSMS.
*
* QKSMS is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* QKSMS is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with QKSMS. If not, see <http://www.gnu.org/licenses/>.
*/
package dev.octoshrimpy.quik.blocking
import io.reactivex.Completable
import io.reactivex.Single
interface BlockingClient {
enum class Capability {
BLOCK_WITHOUT_PERMISSION,
BLOCK_WITH_PERMISSION ,
CANT_BLOCK
}
sealed class Action {
class Block(val reason: String? = null) : Action()
object Unblock : Action()
// We only need these for Should I Answer, because they don't allow us to block numbers in their app directly.
// This means there's a good chance that if a number is blocked in QK, it won't be blocked there, so we
// shouldn't unblock the conversation in that case
object DoNothing : Action()
override fun toString(): String {
return when (this) {
is Block -> "Block"
is Unblock -> "Unblock"
is DoNothing -> "DoNothing"
}
}
}
/**
* Returns true if the target blocking client is available for use, ie. it is installed
*/
fun isAvailable(): Boolean
/**
* Returns the level of access that the given blocking client provides to QKSMS
*/
fun getClientCapability(): Capability
/**
* Returns the recommendation action to perform given a message from the [address]
*/
fun shouldBlock(address: String): Single<Action>
/**
* Returns whether or not the [address] is in the blocking manager's blacklist
* In most cases this will return the same result as [shouldBlock], but it's possible for an app's blacklist
* to be temporarily deactivated, in which case the results will differ
*/
fun isBlacklisted(address: String): Single<Action>
/**
* Blocks the numbers or opens the manager
*/
fun block(addresses: List<String>): Completable
/**
* Unblocks the numbers or opens the manager
*/
fun unblock(addresses: List<String>): Completable
/**
* Opens the settings page for the blocking manager
*/
fun openSettings()
}