org.gbanga.api
Class DownloadRequest

java.lang.Object
  org.gbanga.api.DownloadRequest

public class DownloadRequest
extends java.lang.Object

A DownloadRequest indicates whether a request for a download SMS was successful.

It contains:

• A flag that indicates whether support for the phone model is experimental
• A flag that indicates whether the request was successfully handled
• The cell phone number to which the SMS was sent if successful
• An optional message, e.g. the SMS that was sent to the user
• An optional description e.g. to indicate the reason why the request failed

HideIfNull indicates that the field is not sent at all, if the value is not set.

Author:

Julio

Field Summary

java.lang.String	description An optional description, e.g. the reason why the request failed (phone model not currently supported, unknown phone model etc.).
boolean	isExperimental Indicates whether support for the phone model is experimental.
java.lang.String	message An optional message, e.g. the SMS that was sent to the user upon success.
java.lang.String	phoneNumber The cell phone number to which the SMS was sent.
boolean	success Indicates whether the request was successfully handled.

Constructor Summary

DownloadRequest()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

@HideIfNull
public java.lang.String description

An optional description, e.g. the reason why the request failed (phone model not currently supported, unknown phone model etc.).

isExperimental

public boolean isExperimental

Indicates whether support for the phone model is experimental.

message

@HideIfNull
public java.lang.String message

An optional message, e.g. the SMS that was sent to the user upon success.

phoneNumber

@HideIfNull
public java.lang.String phoneNumber

The cell phone number to which the SMS was sent.

success

public boolean success

Indicates whether the request was successfully handled.

Constructor Detail

DownloadRequest

public DownloadRequest()