Janrain: User management platform for the social web

JRSmsObject Class Reference

An SMS a user can send to share an activity. More...

Inherits Serializable.

List of all members.

Private Attributes

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

String mBody
List< String > mUrls

Constructors

Constructors for the JRSmsObject

 JRSmsObject ()
 JRSmsObject (String body)

Getters/Setters

Getters for the JRSmsObject's private properties

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

Detailed Description

An SMS a user can send to share an activity.

JRSmsObject is a simple container object for a pre-composed SMS to be attached to a JRActivityObject

Instantiate a new JRSmsObject with 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 SMS object.

JRSmsObject ( String  body)

Create an SMS object with a given body.

Parameters:
bodyThe SMS's body, which will be appended to the user's comment and passed to the device's SMS application

Member Function Documentation

String getBody ( )

Getter for the SMS object's mBody property.

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

Setter for the SMS object's mBody property.

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

Getter for the SMS 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 SMS 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 SMS.

Parameters:
urlsThe SMS 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 mBody [private]

The pre-composed body of the SMS.

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

The 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 SMS.

Getter/Setter:
getUrls(), setUrls()

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