android-sdk-base/com.braze.support/ValidationUtils

ValidationUtils

object ValidationUtils

Useful validation methods for checking user input.

Properties

BRAZE_STRING_MAX_LENGTH

const val BRAZE_STRING_MAX_LENGTH: Int = 255

EMAIL_ADDRESS_MAX_LENGTH

const val EMAIL_ADDRESS_MAX_LENGTH: Int = 255

EMAIL_ADDRESS_REGEX

private val EMAIL_ADDRESS_REGEX: ERROR CLASS: Unresolved name: Regex

Regular expression that validates an email address. Emails passing this very simple regex may still be rejected on the Braze server. We want to err on the side of letting things through.

ENDPOINT_REGEX

private val ENDPOINT_REGEX: ERROR CLASS: Unresolved name: Regex

LINE_ID_MAX_LENGTH

const val LINE_ID_MAX_LENGTH: Int = 33

PHONE_NUMBER_REGEX

private val PHONE_NUMBER_REGEX: ERROR CLASS: Unresolved name: Regex

VALID_CURRENCY_CODES

val VALID_CURRENCY_CODES: ERROR CLASS: Unresolved name: setOf

ISO 4217 currency codes accepted by the Braze SDK.

Functions

ensureBrazeFieldLength

fun ensureBrazeFieldLength(field: String?): String

isInvalidCustomEndpoint

internal fun isInvalidCustomEndpoint(customEndpoint: String?): Boolean

isValidEmailAddress

fun isValidEmailAddress(emailAddress: String?): Boolean

Validates an email address. Note that passing this stage of validation allows an email address to be sent to Braze server, which may perform additional validation.

isValidLineId

fun isValidLineId(lineId: String?): Boolean

Validates a user's LINE ID. The ID must be 33 characters or less.

isValidLocation

fun isValidLocation(latitude: Double, longitude: Double): Boolean

isValidLogCustomEventInput

fun isValidLogCustomEventInput(eventName: String?, serverConfigStorageProvider: ERROR CLASS: Symbol not found for ServerConfigStorageProvider): Boolean

Validates the event name for the custom event. Invalid event names are null or in the blocklist.

isValidLogPurchaseInput

fun isValidLogPurchaseInput(productId: String?, currencyCode: String?, price: BigDecimal?, quantity: Int, serverConfigStorageProvider: ERROR CLASS: Symbol not found for ServerConfigStorageProvider): Boolean

Validates the log purchase event parameters.

isValidPhoneNumber

fun isValidPhoneNumber(phoneNumber: String?): Boolean

Performs basic validation on the input phone number. Note that passing this stage of validation allows a phone number to be sent to Braze server, which may perform additional validation.

isValidPushStoryClickInput

fun isValidPushStoryClickInput(campaignId: String?, pageId: String?): Boolean

Validates the campaign id and page id for the push story click. Neither can be null or blank.