//[](../../../index.html)/[pro.streem.sdk](../index.html)/[Streem](index.html)/[createInvitation](create-invitation.html)

createInvitation

[androidJvm]
abstract fun createInvitation(toUserName: String, referenceId: String? = null, integrationId: String? = null, phone: String? = null, invitationType: Streem.InvitationType, resultCallback: (Streem.CreateInvitationResult) -> Unit)

Creates an invitation to streem, and returns invitation information for display to the user.

Parameters

androidJvm

toUserName	the full name of the user that is being invited to streem.
referenceId	a referenceId for the invitation (optional).
integrationId	an integrationId for the invitation (optional).
phone	the user’s phone number (optional). phone must start with a country code (+1 in the US, for instance). If a phone number is provided, the invitation is sent to the phone number via SMS. If no phone number is provided, the invitation code and url available to the resultCallback function parameter in StreemInvitation must be delivered to the user via other means.
invitationType	the delivery mechanism for the invitation. If InvitationType.PHONE, then phone must be provided.
resultCallback	a function that is called with the CreateInvitationResult.