org.deviceconnect.android.profile

クラス FileProfile

java.lang.Object

org.deviceconnect.android.profile.DConnectProfile

org.deviceconnect.android.profile.FileProfile

非推奨です。

swagger定義ファイルで定数を管理することになったので、このクラスは使用しないこととする。 プロファイルを実装する際は本クラスではなく、DConnectProfile クラスを継承すること。

public abstract class FileProfile
extends DConnectProfile

File プロファイル.

スマートデバイスに対してのファイル操作機能を提供するAPI.
スマートデバイスに対してのファイル操作機能を提供するデバイスプラグインは当クラスを継承し、対応APIを実装すること。

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.deviceconnect.android.profile.DConnectProfile

DConnectProfile.Responder

フィールドのサマリー

クラスから継承されたフィールド org.deviceconnect.android.profile.DConnectProfile

mApis, mLogger

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileProfile(FileManager fileMgr) 非推奨です。 コンストラクタ.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
static byte[]	getData(android.content.Intent request) 非推奨です。 リクエストから画像ファイルのバイナリを取得する.
protected FileManager	getFileManager() 非推奨です。 FileManagerのインスタンスを取得する.
static java.lang.String	getFileName(android.content.Intent request) 非推奨です。 リクエストからファイル名を取得する.
static java.lang.Integer	getLimit(android.content.Intent request) 非推奨です。 リクエストからリミットを取得する.
static java.lang.String	getMIMEType(android.content.Intent request) 非推奨です。 リクエストからファイルのMIMEタイプを取得する.
static java.lang.Integer	getOffset(android.content.Intent request) 非推奨です。 リクエストからオフセットを取得する.
static java.lang.String	getOrder(android.content.Intent request) 非推奨です。 リクエストからオーダーを取得する.
static java.lang.String	getPath(android.content.Intent request) 非推奨です。 リクエストからファイルパスを取得する.
java.lang.String	getProfileName() 非推奨です。 プロファイル名を取得する.
static java.lang.String	getURI(android.content.Intent request) 非推奨です。 リクエストからファイルのURIを取得する.
boolean	onRequest(android.content.Intent request, android.content.Intent response) 非推奨です。 RESPONSEメソッドハンドラー.
static void	setCount(android.content.Intent response, int count) 非推奨です。 レスポンスにカウントを設定する.
static void	setFileName(android.os.Bundle file, java.lang.String fileName) 非推奨です。 ファイルデータにファイル名を設定する.
static void	setFiles(android.content.Intent response, android.os.Bundle[] files) 非推奨です。 レスポンスにファイルデータ一覧を設定する.
static void	setFiles(android.content.Intent response, java.util.List<android.os.Bundle> files) 非推奨です。 レスポンスにファイルデータ一覧を設定する.
static void	setFileSize(android.os.Bundle file, long fileSize) 非推奨です。 ファイルデータにファイルサイズを設定する.
static void	setFileType(android.content.Intent response, FileType fileType) 非推奨です。 レスポンスにファイルタイプを設定する.
static void	setMIMEType(android.os.Bundle file, java.lang.String mimeType) 非推奨です。 ファイルデータにファイルのMIMEタイプを設定する.
static void	setMIMEType(android.content.Intent response, java.lang.String mimeType) 非推奨です。 メッセージににファイルのMIMEタイプを設定する.
static void	setPath(android.os.Bundle file, java.lang.String path) 非推奨です。 ファイルデータにファイルパスを設定する.
static void	setUpdateDate(android.os.Bundle file, java.lang.String updateDate) 非推奨です。 ファイルデータに更新日を設定する.
static void	setURI(android.content.Intent response, java.lang.String uri) 非推奨です。 レスポンスにファイルのURIを設定する.
void	setURI(android.content.Intent response, java.lang.String name, byte[] data) 非推奨です。 レスポンスにファイルを設定する.

クラスから継承されたメソッド org.deviceconnect.android.profile.DConnectProfile

addApi, findApi, findApi, getAccessToken, getApi, getApiList, getAttribute, getContentData, getContext, getData, getInterface, getOrigin, getPluginContext, getProduct, getProfile, getRequestCode, getResult, getService, getServiceID, getSessionKey, getVersion, hasApi, isEqual, isIgnoredProfile, isUseLocalOAuth, parseBoolean, parseBoolean, parseByte, parseByte, parseDouble, parseDouble, parseFloat, parseFloat, parseInteger, parseInteger, parseLong, parseLong, parseShort, parseShort, removeApi, sendEvent, sendEvent, sendResponse, setAccessToken, setApi, setAttribute, setContext, setInterface, setPluginContext, setProduct, setProfile, setRequestCode, setResponder, setResult, setService, setServiceID, setSessionKey, setUnsupportedError, setVersion

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

FileProfile

public FileProfile(FileManager fileMgr)

非推奨です。

コンストラクタ.

パラメータ:

fileMgr - ファイル管理クラス

メソッドの詳細

getProfileName

public final java.lang.String getProfileName()

非推奨です。

クラスからコピーされた説明: DConnectProfile

プロファイル名を取得する.

定義:

getProfileName クラス内 DConnectProfile

戻り値:

プロファイル名

onRequest

public boolean onRequest(android.content.Intent request,
                         android.content.Intent response)

非推奨です。

クラスからコピーされた説明: DConnectProfile

RESPONSEメソッドハンドラー.

DConnectApi.onRequest(Intent, Intent)を実行する. そうでない場合は、即座にエラーレスポンスを送信する.

オーバーライド:

onRequest クラス内 DConnectProfile

パラメータ:

request - リクエストパラメータ

response - レスポンスパラメータ

戻り値:

レスポンスパラメータを送信するか否か

setURI

public static void setURI(android.content.Intent response,
                          java.lang.String uri)

非推奨です。

レスポンスにファイルのURIを設定する.

パラメータ:

response - レスポンスパラメータ

uri - ファイルのURI

setURI

public final void setURI(android.content.Intent response,
                         java.lang.String name,
                         byte[] data)
                  throws java.io.IOException

非推奨です。

レスポンスにファイルを設定する. この中で引数に指定したファイルをFileManagerに保存し、uriを作成して レスポンスにファイルのURIを設定する。

パラメータ:

response - レスポンスパラメータ

name - ファイル名

data - uriパラメータから取得できるファイルのデータ。uriパラメータが省略された場合はnullが渡される。

例外:

java.io.IOException - ファイルの保存に失敗した場合に発生

setPath

public static void setPath(android.os.Bundle file,
                           java.lang.String path)

非推奨です。

ファイルデータにファイルパスを設定する.

パラメータ:

file - ファイルデータ

path - ファイルパス

setUpdateDate

public static void setUpdateDate(android.os.Bundle file,
                                 java.lang.String updateDate)

非推奨です。

ファイルデータに更新日を設定する.

パラメータ:

file - ファイルデータ

updateDate - 更新日

setMIMEType

public static void setMIMEType(android.os.Bundle file,
                               java.lang.String mimeType)

非推奨です。

ファイルデータにファイルのMIMEタイプを設定する.

パラメータ:

file - ファイルデータ

mimeType - MIMEタイプ

setMIMEType

public static void setMIMEType(android.content.Intent response,
                               java.lang.String mimeType)

非推奨です。

メッセージににファイルのMIMEタイプを設定する.

パラメータ:

response - メッセージ

mimeType - MIMEタイプ

setFiles

public static void setFiles(android.content.Intent response,
                            android.os.Bundle[] files)

非推奨です。

レスポンスにファイルデータ一覧を設定する.

パラメータ:

response - レスポンスパラメータ

files - ファイルデータ一覧

setFiles

public static void setFiles(android.content.Intent response,
                            java.util.List<android.os.Bundle> files)

非推奨です。

レスポンスにファイルデータ一覧を設定する.

パラメータ:

response - レスポンスパラメータ

files - ファイルデータ一覧

setFileName

public static void setFileName(android.os.Bundle file,
                               java.lang.String fileName)

非推奨です。

ファイルデータにファイル名を設定する.

パラメータ:

file - ファイルデータ

fileName - ファイル名

setFileSize

public static void setFileSize(android.os.Bundle file,
                               long fileSize)

非推奨です。

ファイルデータにファイルサイズを設定する.

パラメータ:

file - ファイルデータ

fileSize - ファイルサイズ

setCount

public static void setCount(android.content.Intent response,
                            int count)

非推奨です。

レスポンスにカウントを設定する.

パラメータ:

response - レスンポンスデータ

count - カウント

setFileType

public static void setFileType(android.content.Intent response,
                               FileType fileType)

非推奨です。

レスポンスにファイルタイプを設定する.

パラメータ:

response - レスポンスデータ

fileType - ファイルタイプ

getFileName

public static java.lang.String getFileName(android.content.Intent request)

非推奨です。

リクエストからファイル名を取得する.

パラメータ:

request - リクエストパラメータ

戻り値:

ファイル名。無い場合はnullを返す。

getURI

public static java.lang.String getURI(android.content.Intent request)

非推奨です。

リクエストからファイルのURIを取得する.

パラメータ:

request - リクエストパラメータ

戻り値:

ファイルのURI。無い場合はnullを返す。

getMIMEType

public static java.lang.String getMIMEType(android.content.Intent request)

非推奨です。

リクエストからファイルのMIMEタイプを取得する.

パラメータ:

request - リクエストパラメータ

戻り値:

ファイルのMIMEタイプ。無い場合はnullを返す。

getPath

public static java.lang.String getPath(android.content.Intent request)

非推奨です。

リクエストからファイルパスを取得する.

パラメータ:

request - リクエストパラメータ

戻り値:

ファイルパス。無い場合はnullを返す。

getData

public static byte[] getData(android.content.Intent request)

非推奨です。

リクエストから画像ファイルのバイナリを取得する.

パラメータ:

request - リクエストパラメータ

戻り値:

画像ファイルのバイナリ。無い場合はnullを返す。

getOrder

public static final java.lang.String getOrder(android.content.Intent request)

非推奨です。

リクエストからオーダーを取得する.

パラメータ:

request - リクエストデータ

戻り値:

オーダー。無い場合はnullを返す。

getOffset

public static java.lang.Integer getOffset(android.content.Intent request)

非推奨です。

リクエストからオフセットを取得する.

パラメータ:

request - リクエストパラメータ

戻り値:

オフセット。無い場合はnullを返す。

getLimit

public static java.lang.Integer getLimit(android.content.Intent request)

非推奨です。

リクエストからリミットを取得する.

パラメータ:

request - リクエストパラメータ

戻り値:

リミット。無い場合は0を返す。

getFileManager

protected FileManager getFileManager()

非推奨です。

FileManagerのインスタンスを取得する. このクラスで実装されたFileManagerを経由してDevice Connect Managerにファイルを送信する。

戻り値:

FileManagerのインスタンス