Rainbow Android SDK/com.ale.infra.rest.user/InviteUser

InviteUser

@Serializable

Represents the parameters required to invite a user via email, phone number, or user ID in the Rainbow platform. This class is used to construct customized invitations, such as specifying the language or adding a custom message.

Instances of InviteUser should be created using the Builder class.

Types

Builder

data class Builder(email: String? = null, invitedPhoneNumber: String? = null, invitedUserId: String? = null, lang: String? = null, customMessage: String? = null)

Builder class for constructing InviteUser instances.

Properties

customMessage

val customMessage: String?

A custom message to include in the invitation. The maximum length is 100,000 characters. Optional.

val email: String?

The email address of the user to invite. Must be between 3 and 255 characters. Optional.

invitedPhoneNumber

val invitedPhoneNumber: String?

The phone number of the user to invite. Optional.

invitedUserId

val invitedUserId: String?

The Rainbow user ID of the user to invite. Optional.

lang

val lang: String?

The preferred language of the invitation. Should be an ISO 639-1 code (e.g., "en", "fr"). Optional.