Janrain: User management platform for the social web

JREmailObject Class Reference

Object containing content to be shared by email. More...

Inherits Serializable.

List of all members.

Private Attributes

The various properties of the JREmailObject that you can access and configure through the object's constructor and getters

String mSubject
String mBody
List< String > mUrls

Constructors

Constructors for the JREmailObject

 JREmailObject ()
 JREmailObject (String subject, String body)

Getters/Setters

Getters for the JREmailObject's private properties

String getSubject ()
void setSubject (String subject)
String getBody ()
void setBody (String body)
List< String > getUrls ()
void setUrls (List< String > urls)
void addUrl (String url)

Detailed Description

Object containing content to be shared by email.

JREmailObject is a simple container object for a pre-composed email to be attached to a JRActivityObject.

Instantiate a new JREmailObject with a subject and a body. Optionally, add a list of URLs from the body and Engage will automatically shorten them, track click-throughs, and provide analytics on your dashboard.


Constructor

Create an empty email object.

JREmailObject ( String  subject,
String  body 
)

Create an email object with a given subject and body.

Parameters:
subjectThe email's subject line, passed to the device's email application
bodyThe email's body, which will be appended to the user's comment and passed to the device's email application.

Member Function Documentation

String getSubject ( )

Getter for the email object's mSubject property.

Returns:
The subject of the email
void setSubject ( String  subject)

Setter for the email object's mSubject property.

Parameters:
subjectThe subject of the email
String getBody ( )

Getter for the email object's mBody property.

Returns:
The body of the email
void setBody ( String  body)

Setter for the email object's mBody property.

Parameters:
bodyThe body of the email
List<String> getUrls ( )

Getter for the email object's mUrls property, a list of URLs to be shortened.

Returns:
An immutable list of URLs to be shortened
void setUrls ( List< String >  urls)

Setter for the email object's mUrls property, a list of URLs to be shortened. Each of these URLs will be shortened to an rpx.me URL, which tracks click-throughs, and provides analytics. Once shortened, the Engage for Android library will substitute the shortened version for the original long version for each URL found in the body of the email.

Parameters:
urlsThe email object's list of URLs to be shortened, not more than five URLs
void addUrl ( String  url)

Add a single URL to the list of URLs to shorten.

Parameters:
urlThe URL to add to the list of URLs to shorten

Variables

String mSubject [private]

The pre-composed subject of the email.

Getter/Setter:
getSubject(), setSubject()
String mBody [private]

The pre-composed body of the email.

Getter/Setter:
getBody(), setBody()
List<String> mUrls [private]

The list of URLs found in the body that are to be shortened.

Getter/Setter:
getUrls(), setUrls(), addUrl()

The documentation for this class was generated from the following file:
  • /Users/nathan/android-code/engage.android/JREngage/src/com/janrain/android/engage/types/JREmailObject.java
Copyright © 2017 Janrain, Inc.