MessageComposer

The MessageComposer class provides a standard interface for composing and sending SMS or MMS messages. More...

Public Member Functions
void	SetRecipients (params string[] values)
	Sets the initial recipients of the message..
void	SetSubject (string value)
	Sets the initial subject of the message.
void	SetBody (string value)
	Sets the initial content of the message.
void	AddScreenshot (string fileName)
	Captures a screenshot and adds it as an attachment of the message.
void	AddImage (Texture2D image, string fileName, TextureEncodingFormat textureEncodingFormat=TextureEncodingFormat.JPG)
	Adds specified image as an attachment of the message.
void	AddAttachment (byte[] data, string mimeType, string fileName)
	Adds the specified data as an attachment of the message.
void	SetCompletionCallback (EventCallback< MessageComposerResult > callback)
	Specify the action to execute after the composer is dismissed.
void	Show ()
	Shows the message composer interface with values initially set.

Static Public Member Functions
static MessageComposer	CreateInstance ()
	Initializes a new instance of the MessageComposer class.
static bool	CanSendText ()
	Returns a Boolean value indicating whether the current device is capable of sending text messages.
static bool	CanSendAttachments ()
	Returns a Boolean value indicating whether or not messages can include attachments.
static bool	CanSendSubject ()
	Returns a Boolean value indicating whether or not messages can include subject lines.

Detailed Description

Before presenting the interface, populate the fields with the set of initial recipients and the message you want to send. After presenting the interface, the user can edit your initial values before sending the message.

The following code example shows how to compose text message.

using UnityEngine;
using System.Collections;
using VoxelBusters.EssentialKit;
 
public class ExampleClass : MonoBehaviour 
{
    public void Start()
    {
        if (MessageComposer.CanSendText())
        {
            // create new instance and populate fields
            MessageComposer newComposer = MessageComposer.CreateInstance();
            newComposer.SetBody("Lorem ipsum dolor sit amet");
            newComposer.SetCompletionCallback(OnMessageComposerClosed);
            newComposer.Show();
        }
        else
        {
            // device doesn't support sending emails
        }
    }
 
    private void OnMessageComposerClosed(MessageComposerResult result, Error error)
    {
        // add your code
    }
}

Member Function Documentation

CanSendText()

static bool CanSendText ( )

static

Returns

true, if the device can send text messages, false otherwise.

CanSendAttachments()

static bool CanSendAttachments ( )

static

Returns

true, if the device can send attachments in MMS or iMessage messages, false otherwise.

Referenced by SharingServices.ShowMessageComposer().

CanSendSubject()

static bool CanSendSubject ( )

static

Returns

true, if the device can include subject lines in messages, false otherwise.

Referenced by SharingServices.ShowMessageComposer().

SetRecipients()

void SetRecipients

(

params string[]

values

)

Parameters

values

An array of string values containing the initial recipients of the message.

SetSubject()

void SetSubject

(

string

value

)

Parameters

value

The initial subject for a message.

SetBody()

void SetBody

(

string

value

)

Parameters

value

The initial content in the body of a message.

AddScreenshot()

void AddScreenshot

(

string

fileName

)

Parameters

fileName

The preferred filename to associate with the image.

AddImage()

void AddImage	(	Texture2D	image,
		string	fileName,
		TextureEncodingFormat	textureEncodingFormat = TextureEncodingFormat::JPG )

Parameters

image	The image that has to be added as an attachment.
fileName	The preferred filename to associate with the image.
textureEncodingFormat	Texture encoding format.

AddAttachment()

void AddAttachment	(	byte[]	data,
		string	mimeType,
		string	fileName )

Parameters

data	The data of the file that has to be added as an attachment.
mimeType	The MIME type of the specified data.
fileName	The filename of the specified data.

SetCompletionCallback()

void SetCompletionCallback

(

EventCallback< MessageComposerResult >

callback

)

Parameters

callback

The action to be called on completion.