Localz Mobile SDK

ChatMyWay SDK/com.localz.chatmyway.models/Contact

Contact

data class Contact(val channelId: String?, val siteId: String?, val storeCode: String?, val orderNumber: String?, val subProjectId: String?, val stopId: String?, val routeId: String?, val title: String, val subtitle: String?, val contactType: ContactType)

Represents a contact that can be used to start a new or resume an existing conversation.

A contact can be associated with a site (2-way conversation), an order (3-way conversation), or a stop (3-way conversation).

Constructors

constructor(channelId: String?, siteId: String?, storeCode: String?, orderNumber: String?, subProjectId: String?, stopId: String?, routeId: String?, title: String, subtitle: String?, contactType: ContactType)

Properties

val channelId: String?

The ID of an existing conversation with this contact. Null if no conversation exists.

val contactType: ContactType

The type of the contact (ContactType.SITE, ContactType.ORDER, ContactType.STOP, or ContactType.UNKNOWN).

val orderNumber: String?

The order number for an ContactType.ORDER contact. Null otherwise.

val routeId: String?

The ID of the route for a ContactType.STOP contact. Null otherwise.

val siteId: String?

The ID of the site for a ContactType.SITE contact. Null otherwise.

val stopId: String?

The ID of the stop for a ContactType.STOP contact. Null otherwise.

val storeCode: String?

The store code associated with a ContactType.SITE contact. Null otherwise.

val subProjectId: String?

The ID of the sub-project for ContactType.ORDER contacts. Null otherwise or if the order is not part of a sub-project.

val subtitle: String?

Additional contextual information about the contact (e.g., Site Address, Customer Name).

val title: String

The main title or name of the contact (e.g., Site Name, Order Title, Stop Address).