概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
NTT DOCOMO and Hitachi Kokusai Electric Know-how & Confidential
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

com.docomo_um.module.net
クラス ShortMessage

java.lang.Object
  上位を拡張 com.docomo_um.module.net.ShortMessage

public class ShortMessage
extends java.lang.Object

ショートメッセージ(SMS・CBS・ETWS)を表すクラスです。 SMS・CBS・ETWSは便宜上ShortMessageとして一つのクラスにまとめています。

SMS、SMSステータスレポートの受信直後のメッセージは STAT_UNREAD 状態です。 エリアメール(CBS・ETWS)の受信直後のメッセージはSTAT_UNREAD状態です。 MessageBox.get(int) や MessageBox.get(String) にてメッセージを取得すると、 取得したメッセージは STAT_READ 状態となります。
ShortMessage クラスのインスタンス生成直後は STAT_UNSENT 状態です。 ShortMessageBox.send(int, boolean, int) や ShortMessageBox.send(ShortMessage, boolean, int) にてメッセージを送信すると、 送信したメッセージは STAT_SENT 状態となります。

フィールドの概要
static int ATTR_DCS
          ショートメッセージの属性情報の一つで、Data Coding Schemeを表します。
static int ATTR_DT
          ショートメッセージの属性情報の一つで、センター送信時刻を表します。
static int ATTR_FO
          ショートメッセージの属性情報の一つで、第1オクテット情報を表します。
static int ATTR_FROM_PHONE_NUMBER
          ショートメッセージの属性情報の一つで、差出人の電話番号を表します。
static int ATTR_FROM_PHONE_NUMBER_TYPE
          ショートメッセージの属性情報の一つで、差出人の電話番号種別を表します。
static int ATTR_LENGTH
          ショートメッセージの属性情報の一つで、メッセージ長を表します。
static int ATTR_MESSAGE_TYPE
          ショートメッセージの属性情報の一つで、ショートメッセージ種別を表します。
static int ATTR_MID
          ショートメッセージの属性情報の一つで、メッセージIDを表します。
static int ATTR_MR
          ショートメッセージの属性情報の一つで、メッセージ送信番号を表します。
static int ATTR_PID
          ショートメッセージの属性情報の一つで、プロトコルIDを表します。
static int ATTR_SCA
          ショートメッセージの属性情報の一つで、SMSセンター番号を表します。
static int ATTR_SCTS
          ショートメッセージの属性情報の一つで、センター到着時刻を表します。
static int ATTR_SN
          ショートメッセージの属性情報の一つで、シリアル番号を表します。
static int ATTR_ST
          ショートメッセージの属性情報の一つで、送信結果を表します。
static int ATTR_STAT
          ショートメッセージの属性情報の一つで、メッセージ状態を表します。
static int ATTR_TOSCA
          ショートメッセージの属性情報の一つで、国際アクセスコードを表します。
static int ATTR_VP
          ショートメッセージの属性情報の一つで、有効期間を表します。
static java.lang.String SEND_RESULT_FAILURE
          ショートメッセージの属性情報である「送信結果(ATTR_ST)」の一つで、送信失敗を表します。
static java.lang.String SEND_RESULT_SUCCESS
          ショートメッセージの属性情報である「送信結果(ATTR_ST)」の一つで、送信成功を表します。
static java.lang.String STAT_READ
          メッセージ状態の一つで、既読を表します。
static java.lang.String STAT_SENT
          メッセージ状態の一つで、送信済みを表します。
static java.lang.String STAT_UNREAD
          メッセージ状態の一つで、未読を表します。
static java.lang.String STAT_UNSENT
          メッセージ状態の一つで、未送信を表します。
static java.lang.String TYPE_CBS_ETWS
          ショートメッセージ種別の一つで、エリアメール(CBS_ETWS)を表します。
static java.lang.String TYPE_SMS
          ショートメッセージ種別の一つで、SMSを表します。
static java.lang.String TYPE_SMS_STATUS_REPORT
          ショートメッセージ種別の一つで、SMSステータスレポートを表します。
 
コンストラクタの概要
ShortMessage()
          SMS送信用のインスタンスを生成します。
 
メソッドの概要
 java.lang.String getAttribute(int attr)
          ショートメッセージの属性を取得します。
 java.lang.String getFormat()
          本インスタンスのメッセージ形式を取得します。
 java.lang.String getMessage()
          本文を取得します。
 int getMessageNumber()
          メッセージ番号を取得します。
 java.lang.String getToPhoneNumber()
          送信先の電話番号を取得します。
 java.lang.String getToPhoneNumberType()
          送信先の電話番号種別を取得します。
 void setMessage(java.lang.String message)
          本文を設定します。
 void setToPhoneNumber(java.lang.String phoneNumber)
          送信先の電話番号を設定します。
 void setToPhoneNumberType(java.lang.String type)
          送信先の電話番号種別を設定します。
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait
 

フィールドの詳細

ATTR_MESSAGE_TYPE

public static final int ATTR_MESSAGE_TYPE
ショートメッセージの属性情報の一つで、ショートメッセージ種別を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_STAT

public static final int ATTR_STAT
ショートメッセージの属性情報の一つで、メッセージ状態を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_FROM_PHONE_NUMBER

public static final int ATTR_FROM_PHONE_NUMBER
ショートメッセージの属性情報の一つで、差出人の電話番号を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_FROM_PHONE_NUMBER_TYPE

public static final int ATTR_FROM_PHONE_NUMBER_TYPE
ショートメッセージの属性情報の一つで、差出人の電話番号種別を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_SCTS

public static final int ATTR_SCTS
ショートメッセージの属性情報の一つで、センター到着時刻を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_FO

public static final int ATTR_FO
ショートメッセージの属性情報の一つで、第1オクテット情報を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_PID

public static final int ATTR_PID
ショートメッセージの属性情報の一つで、プロトコルIDを表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_DCS

public static final int ATTR_DCS
ショートメッセージの属性情報の一つで、Data Coding Schemeを表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_SCA

public static final int ATTR_SCA
ショートメッセージの属性情報の一つで、SMSセンター番号を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_TOSCA

public static final int ATTR_TOSCA
ショートメッセージの属性情報の一つで、国際アクセスコードを表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_LENGTH

public static final int ATTR_LENGTH
ショートメッセージの属性情報の一つで、メッセージ長を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_VP

public static final int ATTR_VP
ショートメッセージの属性情報の一つで、有効期間を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_SN

public static final int ATTR_SN
ショートメッセージの属性情報の一つで、シリアル番号を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_MID

public static final int ATTR_MID
ショートメッセージの属性情報の一つで、メッセージIDを表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_MR

public static final int ATTR_MR
ショートメッセージの属性情報の一つで、メッセージ送信番号を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_DT

public static final int ATTR_DT
ショートメッセージの属性情報の一つで、センター送信時刻を表します。

関連項目:
getAttribute(int), 定数フィールド値

ATTR_ST

public static final int ATTR_ST
ショートメッセージの属性情報の一つで、送信結果を表します。

関連項目:
getAttribute(int), 定数フィールド値

TYPE_SMS

public static final java.lang.String TYPE_SMS
ショートメッセージ種別の一つで、SMSを表します。

関連項目:
getAttribute(int), 定数フィールド値

TYPE_CBS_ETWS

public static final java.lang.String TYPE_CBS_ETWS
ショートメッセージ種別の一つで、エリアメール(CBS_ETWS)を表します。

関連項目:
getAttribute(int), 定数フィールド値

TYPE_SMS_STATUS_REPORT

public static final java.lang.String TYPE_SMS_STATUS_REPORT
ショートメッセージ種別の一つで、SMSステータスレポートを表します。

関連項目:
getAttribute(int), 定数フィールド値

STAT_READ

public static final java.lang.String STAT_READ
メッセージ状態の一つで、既読を表します。

関連項目:
getAttribute(int), MessageBox.get(String), 定数フィールド値

STAT_UNREAD

public static final java.lang.String STAT_UNREAD
メッセージ状態の一つで、未読を表します。

関連項目:
getAttribute(int), MessageBox.get(String), 定数フィールド値

STAT_SENT

public static final java.lang.String STAT_SENT
メッセージ状態の一つで、送信済みを表します。

関連項目:
getAttribute(int), MessageBox.get(String), 定数フィールド値

STAT_UNSENT

public static final java.lang.String STAT_UNSENT
メッセージ状態の一つで、未送信を表します。

関連項目:
getAttribute(int), MessageBox.get(String), 定数フィールド値

SEND_RESULT_SUCCESS

public static final java.lang.String SEND_RESULT_SUCCESS
ショートメッセージの属性情報である「送信結果(ATTR_ST)」の一つで、送信成功を表します。

関連項目:
getAttribute(int), 定数フィールド値

SEND_RESULT_FAILURE

public static final java.lang.String SEND_RESULT_FAILURE
ショートメッセージの属性情報である「送信結果(ATTR_ST)」の一つで、送信失敗を表します。

関連項目:
getAttribute(int), 定数フィールド値
コンストラクタの詳細

ShortMessage

public ShortMessage()
SMS送信用のインスタンスを生成します。

インスタンス生成時の初期状態は、STAT_UNSENT になります。

メソッドの詳細

setToPhoneNumber

public void setToPhoneNumber(java.lang.String phoneNumber)
送信先の電話番号を設定します。

nullを指定すると既に設定してある電話番号は削除されます。

パラメータ:
phoneNumber - 送信先の電話番号を指定します。電話番号は"090********"のように数字の羅列で指定します。
例外:
java.lang.IllegalArgumentException - 桁数の上限を超えるphoneNumberを指定した場合や、不正なフォーマット（電話番号にハイフンが入っているなど）のphoneNumberを指定した場合に発生します。
java.lang.IllegalStateException - 本インスタンスがPDUモードの場合に発生します。

setToPhoneNumberType

public void setToPhoneNumberType(java.lang.String type)
送信先の電話番号種別を設定します。

nullを指定すると既に設定してある電話番号種別は削除されます。

パラメータ:
type - 送信先の電話番号種別を指定します。電話番号種別は10進文字列で指定します。
例外:
java.lang.IllegalArgumentException - 不正なtypeを指定した場合に発生します。
java.lang.IllegalStateException - 本インスタンスがPDUモードの場合に発生します。

setMessage

public void setMessage(java.lang.String message)
本文を設定します。

nullを指定すると既に設定してある本文は削除されます。

本インスタンスがTEXTモードに設定されている場合、 140バイトを超える本文を設定すると、IllegalArgumentExceptionが発生します。 バイト数は文字コードをUCS2として評価します。

本インスタンスがPDUモードに設定されている場合、 "0001000B81"の様にヘッダ情報も含めてPDUのバイナリ値を16進数の数字の羅列で入力します。 このとき設定したヘッダ情報のサイズが18バイトを超えた場合、または本文のサイズが140バイトを超えた場合、IllegalArgumentExceptionが発生します。 また、ヘッダ情報のフォーマットが不正な場合、IllegalArgumentExceptionが発生します。

パラメータ:
message - 本文を指定します。
例外:
java.lang.IllegalArgumentException - 不正な本文を指定した場合に発生します。

getToPhoneNumber

public java.lang.String getToPhoneNumber()
送信先の電話番号を取得します。

戻り値:
送信先の電話番号を返します。送信先の電話番号が設定されていない場合、nullを返します。
例外:
java.lang.IllegalStateException - 本インスタンスがPDUモードの場合に発生します。

getToPhoneNumberType

public java.lang.String getToPhoneNumberType()
送信先の電話番号種別を取得します。

戻り値:
送信先の電話番号種別を返します。 電話番号種別は10進文字列で返します。 送信先の電話番号種別が設定されていない場合、nullを返します。
例外:
java.lang.IllegalStateException - 本インスタンスがPDUモードの場合に発生します。

getMessage

public java.lang.String getMessage()
本文を取得します。

本インスタンスがPDUモードに設定されている場合、 "0001000B81"の様にヘッダ情報も含めてPDUのバイナリ値を16進数の数字の羅列で返します。

戻り値:
本文を返します。本文が設定されていない場合、nullを返します。

getAttribute

public java.lang.String getAttribute(int attr)
ショートメッセージの属性を取得します。

本メソッドは引数で指定した属性に対応する属性値を返します。属性値が設定されていない場合はnullを返します。

パラメータ:
attr - ショートメッセージの属性情報を指定します。
戻り値:
ショートメッセージの属性値を返します。属性値が設定されていない場合、nullを返します。
例外:
java.lang.IllegalArgumentException - attrに不正な属性情報を指定した場合に発生します。
java.lang.IllegalStateException - 本インスタンスがPDUモードの状態において、 ATTR_MESSAGE_TYPE、ATTR_STAT、ATTR_LENGTH以外の値を引数に指定した場合に発生します。
関連項目:
ATTR_MESSAGE_TYPE, ATTR_STAT, ATTR_FROM_PHONE_NUMBER, ATTR_FROM_PHONE_NUMBER_TYPE, ATTR_SCTS, ATTR_FO, ATTR_PID, ATTR_DCS, ATTR_SCA, ATTR_TOSCA, ATTR_LENGTH, ATTR_VP, ATTR_SN, ATTR_MID, ATTR_MR, ATTR_DT, ATTR_ST, TYPE_SMS, TYPE_CBS_ETWS, TYPE_SMS_STATUS_REPORT, STAT_READ, STAT_UNREAD, STAT_SENT, STAT_UNSENT, SEND_RESULT_SUCCESS, SEND_RESULT_FAILURE

getMessageNumber

public int getMessageNumber()
メッセージ番号を取得します。

メッセージを新規生成した直後のメッセージ番号は0です。0は無効なメッセージ番号です。 ShortMessageBox.save(ShortMessage)メソッドにてメッセージを保存すると、有効なメッセージ番号が付与されます。
本メッセージを削除した場合、本メソッドにて削除前のメッセージ番号を取得できますが、取得したメッセージ番号は無効です。

戻り値:
メッセージ番号を返します。

getFormat

public java.lang.String getFormat()
本インスタンスのメッセージ形式を取得します。

戻り値:
メッセージ形式を返します。
関連項目:
ShortMessageManager.FORMAT_PDU, ShortMessageManager.FORMAT_TEXT
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
Copyright © 2013 NTT DOCOMO, INC. and Hitachi Kokusai Electric Inc. All Rights Reserved.
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド