urbanairship-core/com.urbanairship.contacts/Contact

Contact

Airship contact. A contact is distinct from a channel and represents a "user" within Airship. Contacts may be named and have channels associated with it.

Properties

channelContacts

val channelContacts: Flow<Result<List<ContactChannel>>>

contactConflictListener

var contactConflictListener: ContactConflictListener?

Contact conflict listener.

namedUserId

val namedUserId: String?

The current named user Id.

namedUserIdFlow

val namedUserIdFlow: StateFlow<String?>

Named user Id updates.

Functions

associateChannel

fun associateChannel(channelId: String, channelType: ChannelType)

Associates a channel to the contact.

disassociateChannel

fun disassociateChannel(contactChannel: ContactChannel, optOut: Boolean = true)

Disassociates the contact channel.

editAttributes

fun editAttributes(): AttributeEditor

Edit the attributes associated with this Contact.

editSubscriptionLists

fun editSubscriptionLists(): ScopedSubscriptionListEditor

Edits the subscription lists associated with this Contact.

editTagGroups

fun editTagGroups(): TagGroupsEditor

Edit the tags associated with this Contact.

fetchSubscriptionLists

suspend fun fetchSubscriptionLists(): Result<Map<String, Set<Scope>>>

fetchSubscriptionListsPendingResult

fun fetchSubscriptionListsPendingResult(): PendingResult<Map<String, Set<Scope>>?>

Returns the current set of subscription lists for the current contact.

getSubscriptionLists

fun ~~getSubscriptionLists~~(): PendingResult<Map<String, Set<Scope>>?>

Returns the current set of subscription lists for the current contact.

identify

fun identify(@Size(min = 1, max = 128) externalId: String)

Associates the contact with the given named user identifier.

notifyRemoteLogin

fun notifyRemoteLogin()

registerEmail

fun registerEmail(address: String, options: EmailRegistrationOptions)

Registers an Email channel.

registerOpenChannel

fun registerOpenChannel(address: String, options: OpenChannelRegistrationOptions)

Registers an Open channel.

registerSms

fun registerSms(msisdn: String, options: SmsRegistrationOptions)

Registers a Sms channel.

resendDoubleOptIn

fun resendDoubleOptIn(contactChannel: ContactChannel)

Resends double-opt in for the given contact channel.

reset

fun reset()

Disassociate the channel from its current contact, and create a new un-named contact.

setSmsValidationHandler

fun setSmsValidationHandler(handler: SmsValidationHandler?)

Sets the SMS validation handler, to allow overriding of the default Airship validation.

validateSms

suspend fun validateSms(msisdn: String, sender: String): Boolean

Validates an SMS number.