Initial commit

docs/-synchronizer/validate-address.md

@@ -0,0 +1,19 @@
+[zcash-android-wallet-sdk](../../index.md) / [cash.z.ecc.android.sdk](../index.md) / [Synchronizer](index.md) / [validateAddress](./validate-address.md)
+
+# validateAddress
+
+`abstract suspend fun validateAddress(address: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`AddressType`](../../cash.z.ecc.android.sdk.validate/-address-type/index.md)
+
+Validates the given address, returning information about why it is invalid. This is a
+convenience method that combines the behavior of [isValidShieldedAddr](is-valid-shielded-addr.md) and
+[isValidTransparentAddr](is-valid-transparent-addr.md) into one call so that the developer doesn't have to worry about
+handling the exceptions that they throw. Rather, exceptions are converted to
+[AddressType.Invalid](../../cash.z.ecc.android.sdk.validate/-address-type/-invalid/index.md) which has a `reason` property describing why it is invalid.
+
+### Parameters
+
+`address` - the address to validate.
+
+**Return**
+an instance of [AddressType](../../cash.z.ecc.android.sdk.validate/-address-type/index.md) providing validation info regarding the given address.
+