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

com.docomo_um.module.net
クラス ShortMessageBox

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

public class ShortMessageBox
extends MessageBox

SMSメッセージのメッセージボックスを表すクラスです。

フィールドの概要
static java.lang.String ACTION_TYPE_RECEIVE
          メッセージの操作種別の一つで、メッセージ受信を表します。
static java.lang.String ACTION_TYPE_SEND
          メッセージの操作種別の一つで、メッセージ送信を表します。
static java.lang.String DELETE_TYPE_ALL
          ショートメッセージの削除種別の一つで、すべてのメッセージ削除を表します。
static java.lang.String DELETE_TYPE_READ
          ショートメッセージの削除種別の一つで、既読メッセージの削除を表します。
static java.lang.String DELETE_TYPE_READ_SENT
          ショートメッセージの削除種別の一つで、既読、送信済メッセージの削除を表します。
static java.lang.String DELETE_TYPE_READ_SENT_UNSENT
          ショートメッセージの削除種別の一つで、既読、送信済、未送信メッセージの削除を表します。
static java.lang.String STORAGE_TYPE_MODULE
          SMSメッセージ保存領域の一つで、モジュール本体の保存領域を表します。
static java.lang.String STORAGE_TYPE_UIM
          SMSメッセージ保存領域の一つで、UIMの保存領域を表します。
 
クラス com.docomo_um.module.net.MessageBox から継承されたフィールド
BOX_TYPE_AREA_MAIL, BOX_TYPE_SHORT_MESSAGE, BOX_TYPE_SMS_STATUS_REPORT
 
メソッドの概要
 void delete(int messageNumber)
          メッセージ番号を指定して、メッセージボックスに保存されているメッセージを削除します。
 void delete(java.lang.String type)
          メッセージ状態を指定して、メッセージボックスに保存されているメッセージを削除します。
 ShortMessage get(int messageNumber)
          メッセージ番号を指定して、メッセージボックスに保存されているメッセージを取得します。
 java.util.List<ShortMessage> get(java.lang.String type)
          メッセージ状態を指定して、メッセージボックスに保存されているメッセージを取得します。
 int getSavedMessageNumber(java.lang.String actionType)
          メッセージボックスに保存されているメッセージの数を取得します。
 java.lang.String getStorage(java.lang.String actionType)
          SMSメッセージの保存領域設定を取得します。
 int getTotalMessageNumber(java.lang.String actionType)
          メッセージボックスに保存可能なメッセージの総数を取得します。
 int save(ShortMessage message)
          SMSメッセージを保存します。
 int send(int messageNumber, boolean smssr, int vp)
          保存先のメッセージ番号を指定してSMSメッセージを送信します。
 int send(ShortMessage shortMessage, boolean smssr, int vp)
          メッセージを指定してSMSメッセージを送信します。
 void setStorage(java.lang.String actionType, java.lang.String storageType)
          SMSメッセージの保存領域を設定します。
 
クラス com.docomo_um.module.net.MessageBox から継承されたメソッド
getType
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait
 

フィールドの詳細

DELETE_TYPE_READ

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

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

DELETE_TYPE_READ_SENT

public static final java.lang.String DELETE_TYPE_READ_SENT
ショートメッセージの削除種別の一つで、既読、送信済メッセージの削除を表します。

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

DELETE_TYPE_READ_SENT_UNSENT

public static final java.lang.String DELETE_TYPE_READ_SENT_UNSENT
ショートメッセージの削除種別の一つで、既読、送信済、未送信メッセージの削除を表します。

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

DELETE_TYPE_ALL

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

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

STORAGE_TYPE_MODULE

public static final java.lang.String STORAGE_TYPE_MODULE
SMSメッセージ保存領域の一つで、モジュール本体の保存領域を表します。

関連項目:
setStorage(String, String), getStorage(String), 定数フィールド値

STORAGE_TYPE_UIM

public static final java.lang.String STORAGE_TYPE_UIM
SMSメッセージ保存領域の一つで、UIMの保存領域を表します。

関連項目:
setStorage(String, String), getStorage(String), 定数フィールド値

ACTION_TYPE_SEND

public static final java.lang.String ACTION_TYPE_SEND
メッセージの操作種別の一つで、メッセージ送信を表します。

関連項目:
setStorage(String, String), getStorage(String), 定数フィールド値

ACTION_TYPE_RECEIVE

public static final java.lang.String ACTION_TYPE_RECEIVE
メッセージの操作種別の一つで、メッセージ受信を表します。

関連項目:
setStorage(String, String), getStorage(String), 定数フィールド値
メソッドの詳細

get

public ShortMessage get(int messageNumber)
                 throws DeviceException,
                        ExternalStatusException,
                        ShortMessageException
クラス MessageBox の記述:
メッセージ番号を指定して、メッセージボックスに保存されているメッセージを取得します。

本メソッドにて受信メッセージを取得すると、取得したメッセージは ShortMessage.STAT_READ 状態となります。
本メソッドにて送信メッセージを取得しても、取得したメッセージの状態は変化しません。

定義:
クラス MessageBox 内の get
パラメータ:
messageNumber - 取得するメッセージのメッセージ番号を指定します。
戻り値:
メッセージを返します。
例外:
java.lang.IllegalArgumentException - 指定したmessageNumberに対応するメッセージが保存されていない場合や、messageNumberに別の保存領域のメッセージ番号を指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、正常にメッセージを読み出せなかった場合に発生します。
DeviceException - デバイスの故障により、正常にメッセージを読み出せなかった場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。

get

public java.util.List<ShortMessage> get(java.lang.String type)
                                 throws DeviceException,
                                        ExternalStatusException,
                                        ShortMessageException
クラス MessageBox の記述:
メッセージ状態を指定して、メッセージボックスに保存されているメッセージを取得します。

本メソッドにて受信メッセージを取得すると、取得したメッセージは ShortMessage.STAT_READ 状態となります。
本メソッドにて送信メッセージを取得しても、取得したメッセージの状態は変化しません。

定義:
クラス MessageBox 内の get
パラメータ:
type - 取得するメッセージのメッセージ状態を指定します。
戻り値:
メッセージをリストで返します。メッセージが無い場合は要素数0のリストを返します。
例外:
java.lang.NullPointerException - typeにnullを指定した場合に発生します。
java.lang.IllegalArgumentException - 不正なtypeを指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、正常にメッセージを読み出せなかった場合に発生します。
DeviceException - デバイスの故障により、正常にメッセージを読み出せなかった場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。
関連項目:
ShortMessage.STAT_READ, ShortMessage.STAT_UNREAD, ShortMessage.STAT_SENT, ShortMessage.STAT_UNSENT

delete

public void delete(int messageNumber)
            throws DeviceException,
                   ExternalStatusException,
                   ShortMessageException
クラス MessageBox の記述:
メッセージ番号を指定して、メッセージボックスに保存されているメッセージを削除します。

メッセージの削除により、他のメッセージのメッセージ番号が変更されることはありません。

定義:
クラス MessageBox 内の delete
パラメータ:
messageNumber - 削除するメッセージのメッセージ番号を指定します。
例外:
java.lang.IllegalArgumentException - 指定したmessageNumberにメッセージが保存されていない場合や、messageNumberに別の保存領域のメッセージ番号を指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、メッセージが削除できなかった場合に発生します。
DeviceException - デバイスの故障により、削除に失敗した場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。

delete

public void delete(java.lang.String type)
            throws DeviceException,
                   ExternalStatusException,
                   ShortMessageException
クラス MessageBox の記述:
メッセージ状態を指定して、メッセージボックスに保存されているメッセージを削除します。 指定した状態のすべてのメッセージが削除されます。

メッセージの削除により、他のメッセージのメッセージ番号が変更されることはありません。

定義:
クラス MessageBox 内の delete
パラメータ:
type - 削除するメッセージのメッセージ状態を指定します。
例外:
java.lang.NullPointerException - typeにnullを指定した場合に発生します。
java.lang.IllegalArgumentException - 不正なtypeを指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、メッセージが削除できなかった場合に発生します。
DeviceException - デバイスの故障により、削除に失敗した場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。
関連項目:
DELETE_TYPE_READ, DELETE_TYPE_READ_SENT, DELETE_TYPE_READ_SENT_UNSENT, DELETE_TYPE_ALL

send

public int send(ShortMessage shortMessage,
                boolean smssr,
                int vp)
         throws IllegalSettingException,
                CommunicationFailureException,
                RegulationException,
                ExternalStatusException,
                DeviceException,
                ShortMessageException
メッセージを指定してSMSメッセージを送信します。

本メソッドにてメッセージを送信すると、送信したメッセージは ShortMessage.STAT_SENT 状態となります。
また、本メソッドにてメッセージを送信した場合、送信メッセージは保存されません。

指定したショートメッセージについて、送信電話番号などの送信に必要な情報が設定されていない場合や、 PDUモード時にShortMessage.setMessage(String)にて送信先電話番号など送信に必要な情報が指定されない場合など、 不正なメッセージが指定された場合、IllegalSettingExceptionが発生します。

PDUモードのショートメッセージを送信する場合、本メソッドにて指定した有効期間とSMSステータスレポート受信要求は無視され、 ショートメッセージのヘッダに設定されている有効期限とSMSステータスレポート受信要求が有効となります。

パラメータ:
shortMessage - 送信するショートメッセージを指定します。
smssr - SMSステータスレポートの受信を要求する場合はtrue、そうでない場合はfalseを指定します。
vp - SMS有効期間を日単位で指定します。許容値は0～3です。
戻り値:
メッセージ送信番号を返します。 メッセージ送信番号は送信したSMSメッセージとSMSステータスレポートを紐付ける番号であり、 システム内のメッセージを一意に識別するメッセージ番号とは無関係です。
例外:
java.lang.NullPointerException - shortMessage に null を指定した場合に発生します。
IllegalSettingException - shortMessageに設定されているメッセージの内容が不正な場合や、不正なセンター番号が設定されている場合に発生します。
java.lang.IllegalArgumentException - vpに0～3以外の値を指定した場合に発生します。
CommunicationFailureException - 通信中にエラーが起こった場合に発生します。
RegulationException - 規制による通信失敗の場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、正常にメッセージを送信出来なかった場合に発生します。
DeviceException - デバイスの故障により、正常にメッセージを送信出来なかった場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。

send

public int send(int messageNumber,
                boolean smssr,
                int vp)
         throws IllegalSettingException,
                CommunicationFailureException,
                RegulationException,
                ExternalStatusException,
                DeviceException,
                ShortMessageException
保存先のメッセージ番号を指定してSMSメッセージを送信します。

本メソッドにてメッセージを送信すると、送信したメッセージは ShortMessage.STAT_SENT 状態となります。

PDUモードのショートメッセージを送信する場合、本メソッドにて指定した有効期間とSMSステータスレポート受信要求は無視され、 ショートメッセージのヘッダに設定されている有効期限とSMSステータスレポート受信要求が有効となります。

パラメータ:
messageNumber - 送信するメッセージのメッセージ番号を指定します。
smssr - SMSステータスレポートの受信を要求する場合はtrue、そうでない場合はfalseを指定します。
vp - SMS有効期間を日単位で指定します。許容値は0～3です。
戻り値:
メッセージ送信番号を返します。 SMSステータスレポートを受信する場合、送信したSMSメッセージとSMSステータスレポートはメッセージ送信番号によって紐付けされます。 メッセージ送信番号は送信したSMSメッセージとSMSステータスレポートを紐付ける番号であり、 システム内のメッセージを一意に識別するメッセージ番号とは無関係です。
例外:
java.lang.IllegalArgumentException - 指定したmessageNumberに対応するメッセージが保存されていない場合や、 messageNumberに別の保存領域のメッセージ番号を指定した場合、messageNumberに受信メッセージのメッセージ番号を指定した場合、 vpに0～3以外の値を指定した場合に発生します。
IllegalSettingException - 不正なセンター番号が設定されている場合に発生します。
CommunicationFailureException - 通信中にエラーが起こった場合に発生します。
RegulationException - 規制による通信失敗の場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、正常にメッセージを送信出来なかった場合に発生します。
DeviceException - デバイスの故障により、正常にメッセージを送信出来なかった場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。
関連項目:
save(ShortMessage)

save

public int save(ShortMessage message)
         throws java.lang.IllegalArgumentException,
                ExternalStatusException,
                DeviceException,
                ShortMessageException
SMSメッセージを保存します。

指定したSMSメッセージは送信メッセージの保存領域に保存されます。

指定したショートメッセージについて、送信電話番号などの送信に必要な情報が設定されていない場合や、 PDUモード時にShortMessage.setMessage(String)にて送信先電話番号など送信に必要な情報が指定されない場合など、 不正なメッセージが指定された場合、IllegalArgumentExceptionが発生します。

パラメータ:
message - 保存するSMSメッセージを指定します。
戻り値:
保存先のメッセージ番号を返します。当該メッセージ番号はsend(int, boolean, int) を使用してメッセージを送信する際に引数に指定します。
例外:
java.lang.NullPointerException - messageにnullを指定した場合に発生します。
java.lang.IllegalArgumentException - 設定されているメッセージの内容が不正な場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、メッセージが保存できなかった場合に発生します。
DeviceException - デバイスの故障により、メッセージが保存できなかった場合に発生します。
ShortMessageException - 保存領域の空きがない場合、または内部エラーにより処理が中断した場合に発生します。
関連項目:
send(int, boolean, int)

getTotalMessageNumber

public int getTotalMessageNumber(java.lang.String actionType)
                          throws DeviceException,
                                 ExternalStatusException,
                                 ShortMessageException
メッセージボックスに保存可能なメッセージの総数を取得します。

現在の保存領域に対して、保存可能なメッセージ総数が取得できます。

パラメータ:
actionType - メッセージの操作種別を指定します。
戻り値:
メッセージボックスに保存可能なメッセージの総数を返します。
例外:
java.lang.NullPointerException - actionTypeにnullを指定した場合に発生します。
java.lang.IllegalArgumentException - 不正なactionTypeを指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、保存可能なメッセージ総数を取得できなかった場合に発生します。
DeviceException - デバイスの故障により、保存可能なメッセージ総数を取得できなかった場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。
関連項目:
ACTION_TYPE_RECEIVE, ACTION_TYPE_SEND

getSavedMessageNumber

public int getSavedMessageNumber(java.lang.String actionType)
                          throws DeviceException,
                                 ExternalStatusException,
                                 ShortMessageException
メッセージボックスに保存されているメッセージの数を取得します。

指定した操作種別に設定している保存領域が対象となります。
対象の保存領域に保存されている全メッセージ件数(送信済みメッセージ、未送信メッセージ、受信メッセージの合計件数)を取得します。

パラメータ:
actionType - メッセージの操作種別を指定します。
戻り値:
メッセージボックスに保存されているメッセージの数を返します。
例外:
java.lang.NullPointerException - actionTypeにnullを指定した場合に発生します。
java.lang.IllegalArgumentException - 不正なactionTypeを指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、保存されているメッセージの数を取得できなかった場合に発生します。
DeviceException - デバイスの故障により、保存されているメッセージの数を取得できなかった場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。
関連項目:
ACTION_TYPE_RECEIVE, ACTION_TYPE_SEND

setStorage

public void setStorage(java.lang.String actionType,
                       java.lang.String storageType)
                throws DeviceException,
                       ExternalStatusException,
                       ShortMessageException
SMSメッセージの保存領域を設定します。 受信又は送信を行うための保存領域を設定します。

受信、送信ともに工場出荷時はUIMの保存領域STORAGE_TYPE_UIMです。
設定は電源をOFFしても保持されます。 ただし、モデムモードや他のJavaアプリケーションにより設定が変更されることがあります。

パラメータ:
actionType - メッセージの操作種別を指定します。
storageType - メッセージ保存領域を指定します。
例外:
java.lang.NullPointerException - actionTypeまたはstorageTypeにnullを指定した場合に発生します。
java.lang.IllegalArgumentException - 不正な actionType または不正な storageType を指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、保存領域の設定に失敗した場合に発生します。
DeviceException - デバイスの故障により、保存領域の設定に失敗した場合に発生します。
ShortMessageException - 内部エラーにより処理が中断した場合に発生します。
関連項目:
ACTION_TYPE_SEND, ACTION_TYPE_RECEIVE, STORAGE_TYPE_UIM, STORAGE_TYPE_MODULE

getStorage

public java.lang.String getStorage(java.lang.String actionType)
                            throws ExternalStatusException
SMSメッセージの保存領域設定を取得します。

パラメータ:
actionType - メッセージの操作種別を指定します。
戻り値:
指定したメッセージの操作を行うための保存領域を返します。
例外:
java.lang.NullPointerException - actionTypeにnullを指定した場合に発生します。
java.lang.IllegalArgumentException - 不正なactionTypeを指定した場合に発生します。
ExternalStatusException - UIMが挿入されていない場合など、保存領域の取得に失敗した場合に発生します。
関連項目:
ACTION_TYPE_SEND, ACTION_TYPE_RECEIVE, STORAGE_TYPE_UIM, STORAGE_TYPE_MODULE
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
Copyright © 2013 NTT DOCOMO, INC. and Hitachi Kokusai Electric Inc. All Rights Reserved.
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド