つくる、をつなぐProject Linking

LinkingコアライブラリAPI仕様書 for Android

ver 1.0.0
目次

デバイスへデータを送信

SendNotification

Notificationに相当する内容をLinkingデバイスへ通知するクラス。
送信する情報は通知の本文が必須です。

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

SendNotification(Context context)

引数
Contextcontext送信者自身のコンテキスト

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 setDispNameJa 通知に表示するアプリ名(日本語)の設定を行います。
2 setDispNameEn 通知に表示するアプリ名(英語)の設定を行います。
3 setTitle 通知のタイトルの設定処理を行います。
4 setText 通知の本文の設定処理を行います。
5 setIcon 通知アイコン画像のリソースIDの設定処理を行います。
6 setNotificationID 通知IDの設定処理を行います。
7 setCategoryID 通知カテゴリID(任意の固定データ)の設定処理を行います。
8 setIllumination LEDの鳴動設定処理を行います。
9 setVibration バイブレーションの鳴動設定処理を行います。
10 setBeep ビープ音の鳴動設定処理を行います。
11 setDuration 通知継続時間の設定処理を行います。
12 setDeviceID 対象デバイスIDの設定処理を行います。
13 setDeviceUID 固有ID(複数指定可)の設定処理を行います。
14 send Notification情報のintent送信処理を行います。
15 send 各設定メソッドで値が設定されていた場合は、設定値をintent情報に格納します。
16 clear 設定値のクリアを行います。

メソッド詳細

setDispNameJa
boolean setDispNameJa(String nameJa)
通知に表示するアプリ名(日本語)の設定を行います。
引数
StringnameJa通知に表示するアプリ名(日本語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDispNameEn
boolean setDispNameEn(String nameEn)
通知に表示するアプリ名(英語)の設定を行います。
引数
StringnameEn通知に表示するアプリ名(英語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setTitle
boolean setTitle(String title)
通知のタイトルの設定処理を行います。
引数
Stringtitle通知のタイトル
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setText
boolean setText(String text)
通知の本文の設定処理を行います。
引数
Stringtext通知の本文
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setIcon
boolean setIcon(int icon)
通知アイコン画像のリソースIDの設定処理を行います。
引数
inticon通知アイコン画像のリソースID
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setNotificationID
boolean setNotificationID(int notificationID)
通知IDの設定処理を行います。
引数
intnotificationID通知ID(通知キャンセル時に使用する任意の番号)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setCategoryID
boolean setCategoryID(int categoryID)
通知カテゴリID(任意の固定データ)の設定処理を行います。
引数
intcategoryID通知カテゴリID(任意の固定データ)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setIllumination
boolean setIllumination(byte[] illumination)
LEDの鳴動設定処理を行います。
引数
Byte[]illuminationLED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setVibration
boolean setVibration(byte[] vibration)
バイブレーションの鳴動設定処理を行います。
引数
Byte[]vibrationバイブレーション鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setBeep
boolean setBeep(byte[] beep)
ビープ音の鳴動設定処理を行います。
引数
Byte[]beepビープ音鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDuration
boolean setDuration(byte[] Duration)
通知継続時間の設定処理を行います。
引数
Byte[]Duration通知継続時間
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceID
boolean setDeviceID(int deviceID)
対象デバイスIDの設定処理を行います。
引数
Byte[]deviceID対象デバイスID
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceUID
boolean setDeviceUID(int[] deviceUID)
固有ID(複数指定可)の設定処理を行います。
引数
int[]deviceUID固有ID(複数指定可)LED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
send
int send(String text)
Notification情報のintent送信処理を行います。
パラメータが無い場合は、setTextの設定値が有効になります。
その他に値が設定されていた場合は、設定値をintent情報に格納します。
引数
Stringtext通知の本文
戻り値
OK 正常終了
NG 必須項目( text )が設定されていない為、送信をキャンセル
send
int send()
Notification情報のintent送信処理を行います。
各設定メソッドで値が設定されていた場合は、設定値をintent情報に格納します。
引数
なし
戻り値
OK 正常終了
NG 異常終了
clear
void clear()
設定値のクリアを行います。
send処理後に、設定を無効にしたい場合に使用してください。
引数
なし
戻り値
なし

SendMail

メールに関する内容をLinkingデバイスへ通知するクラス。
送信する情報は送信者のアドレスと、受信時間は必須です。

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

SendMail(Contextcontext)

引数
Contextcontext送信者自身のコンテキスト

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 setDispNameJa 通知に表示するアプリ名(日本語)の設定を行います。
2 setDispNameEn 通知に表示するアプリ名(英語)の設定を行います。
3 setTitle 通知のタイトルの設定処理を行います。
4 setText 通知の本文の設定処理を行います。
5 setAddress 送信者のメールアドレスの設定処理を行います。
6 setSendUser 送信者名の設定処理を行います。
7 setReceiveTime 受信日時の設定処理を行います。
8 setNotificationID 通知IDの設定処理を行います。
9 setCategoryID 通知カテゴリID(任意の固定データ)の設定処理を行います。
10 setIllumination LEDの鳴動設定処理を行います。
11 setVibration バイブレーションの鳴動設定処理を行います。
12 setDuration 通知継続時間の設定処理を行います。
13 setDeviceID 対象デバイスIDの設定処理を行います。
14 setDeviceUID 固有ID(複数指定可)の設定処理を行います。
15 send メール情報のintent送信処理を行います。
16 send 各設定メソッドで値が設定されていた場合は、設定値をintent情報に格納します。
17 clear 設定値のクリアを行います。

メソッド詳細

setDispNameJa
boolean setDispNameJa(String nameJa)
通知に表示するアプリ名(日本語)の設定を行います。
引数
StringnameJa通知に表示するアプリ名(日本語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDispNameEn
boolean setDispNameEn(String nameEn)
通知に表示するアプリ名(英語)の設定を行います。
引数
StringnameEn通知に表示するアプリ名(英語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setTitle
boolean setTitle(String title)
通知のタイトルの設定処理を行います。
引数
Stringtitle通知のタイトル
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setText
boolean setText(String text)
通知の本文の設定処理を行います。
引数
Stringtext通知の本文
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setAddress
boolean setAddress(String address)
送信者のメールアドレスの設定処理を行います。
引数
Stringaddress送信者のメールアドレス
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setSendUser
boolean setSendUser(String sendUser)
送信者名の設定処理を行います。
引数
StringsendUser送信者名
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setReceiveTime
boolean setReceiveTime(long receiveTime)
受信日時の設定処理を行います。
引数
longreceiveTime受信日時(エポックからの経過時間(msec))
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setNotificationID
boolean setNotificationID(int notificationID)
通知IDの設定処理を行います。
引数
IntnotificationID通知ID(通知キャンセル時に使用する任意の番号)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setCategoryID
boolean setCategoryID(int categoryID)
通知カテゴリID(任意の固定データ)の設定処理を行います。
引数
intcategoryID通知カテゴリID(任意の固定データ)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setIllumination
boolean setIllumination(byte[] illumination)
LEDの鳴動設定処理を行います。
引数
Byte[]illuminationLED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setVibration
boolean setVibration(byte[] vibration)
バイブレーションの鳴動設定処理を行います。
引数
Byte[]vibrationバイブレーション鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDuration
boolean setDuration(byte[] Duration)
通知継続時間の設定処理を行います。
引数
Byte[]Duration通知継続時間
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceID
boolean setDeviceID(int deviceID)
対象デバイスIDの設定処理を行います。
引数
intdeviceID対象デバイスID
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceUID
boolean setDeviceUID(int[] deviceUID)
固有ID(複数指定可)の設定処理を行います。
引数
int[]deviceUID固有ID(複数指定可)LED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
send
int send(String address, long receiveTime)
メール情報のintent送信処理を行います。
パラメータが無い場合は、setAddressとsetReceiveTimeの設定値が有効になります。
その他に値が設定されていた場合は、設定値をintent情報に格納します。
引数
Stringaddress送信者のメールアドレス
longreceiveTime受信日時(エポックからの経過時間(msec))
戻り値
OK 正常終了
NG 必須項目(addressとreceiveTime)が設定されていない為、送信をキャンセル
send
int send()
メール情報のintent送信処理を行います。
各設定メソッドで値が設定されていた場合は、設定値をintent情報に格納します。
引数
なし
戻り値
OK 正常終了
NG 異常終了
clear
void clear()
設定値のクリアを行います。
send処理後に、設定を無効にしたい場合に使用してください。
引数
なし
戻り値
なし

SendSchedule

スケジュールに関する内容をLinkingデバイスへ通知するクラス。
送信する情報は、タイトルと開始時間は必須です。

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

SendSchedule (Context context)

引数
Contextcontext送信者自身のコンテキスト

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 setDispNameJa 通知に表示するアプリ名(日本語)の設定を行います。
2 setDispNameEn 通知に表示するアプリ名(英語)の設定を行います。
3 setTitle 通知のタイトルの設定処理を行います。
4 setStartTime 開始日時の設定処理を行います。
5 setEndTime 終了日時の設定処理を行います。
6 setWhere 場所情報の設定処理を行います。
7 setPerson 人の情報の設定処理を行います。
8 setDescription 詳細情報の設定処理を行います。
9 setContent1 内容1データの設定処理を行います。
10 setContent2 内容2データの設定処理を行います。
11 setContent3 内容3データの設定処理を行います。
12 setNotificationID 通知IDの設定処理を行います。
13 setCategoryID 通知カテゴリID(任意の固定データ)の設定処理を行います。
14 setIllumination LEDの鳴動設定処理を行います。
15 setVibration バイブレーションの鳴動設定処理を行います。
16 setDuration 通知継続時間の設定処理を行います。
17 setDeviceID 対象デバイスIDの設定処理を行います。
18 setDeviceUID 固有ID(複数指定可)の設定処理を行います。
19 send スケジュール情報のintent送信処理を行います。
20 send 各設定メソッドで値が設定されていた場合は、設定値をintent情報に格納します。
21 clear 設定値のクリアを行います。

メソッド詳細

setDispNameJa
boolean setDispNameJa(String nameJa)
通知に表示するアプリ名(日本語)の設定を行います。
引数
StringnameJa通知に表示するアプリ名(日本語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDispNameEn
boolean setDispNameEn(String nameEn)
通知に表示するアプリ名(英語)の設定を行います。
引数
StringnameEn通知に表示するアプリ名(英語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setTitle
boolean setTitle(String title)
通知のタイトルの設定処理を行います。
引数
Stringtitle通知のタイトル
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setStartTime
boolean setStartTime(long startTime)
開始日時の設定処理を行います。
引数
longstartTime開始日時(エポックからの経過時間(msec))
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setEndTime
boolean setEndTime(long endTime)
終了日時の設定処理を行います。
引数
longendTime終了日時(エポックからの経過時間(msec))
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setWhere
boolean setWhere(String where)
場所情報の設定処理を行います。
引数
Stringwhere場所の情報
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setPerson
boolean setPerson(String person)
人の情報の設定処理を行います。
引数
Stringperson人の情報
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDescription
boolean setDescription(String description)
詳細情報の設定処理を行います。
引数
Stringdescription詳細情報
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setContent1
boolean setContent1(byte[] content1)
内容1データの設定処理を行います。
引数
byte[]content1内容1データ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setContent2
boolean setContent2(byte[] content2)
内容2データの設定処理を行います。
引数
byte[]content2内容2データ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setContent3
boolean setContent3(byte[] content3)
内容3データの設定処理を行います。
引数
byte[]content3内容3データ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setNotificationID
boolean setNotificationID(int notificationID)
通知IDの設定処理を行います。
引数
intnotificationID通知ID(通知キャンセル時に使用する任意の番号)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setCategoryID
boolean setCategoryID(int categoryID)
通知カテゴリID(任意の固定データ)の設定処理を行います。
引数
intcategoryID通知カテゴリID(任意の固定データ)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setIllumination
boolean setIllumination(byte[] illumination)
LEDの鳴動設定処理を行います。
引数
Byte[]illuminationLED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setVibration
boolean setVibration(byte[] vibration)
バイブレーションの鳴動設定処理を行います。
引数
Byte[]vibrationバイブレーション鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDuration
boolean setDuration(byte[] Duration)
通知継続時間の設定処理を行います。
引数
Byte[]Duration通知継続時間
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceID
boolean setDeviceID(int deviceID)
対象デバイスIDの設定処理を行います。
引数
intdeviceID対象デバイスID
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceUID
boolean setDeviceUID(int[] deviceUID)
固有ID(複数指定可)の設定処理を行います。
引数
int[]deviceUID固有ID(複数指定可)LED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
send
int send(String title, long startTime)
スケジュール情報のintent送信処理を行います。
パラメータが無い場合は、setTitleとstartTimeの設定値が有効になります。
その他に値が設定されていた場合は、設定値をintent情報に格納します。
引数
Stringtitle通知のタイトル
longstartTime開始日時(エポックからの経過時間(msec))
戻り値
OK 正常終了
NG必須項目(textとstartTime)が設定されていない為、送信をキャンセル
send
int send()
スケジュール情報のintent送信処理を行います。
各設定メソッドで値が設定されていた場合は、設定値をintent情報に格納します。
引数
なし
戻り値
OK 正常終了
NG 異常終了
clear
void clear()
設定値のクリアを行います。
send処理後に、設定を無効にしたい場合に使用してください。
引数
なし
戻り値
なし

Send Other

その他の情報をLinkingデバイスへ通知するクラス。
必須項目はありませんが、パラメータの内ひとつでも設定されていないと送信はキャンセルされます。

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

SendOther(Co ntext context)

引数
Contextcontext送信者自身の コンテキスト

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 setDispNameJa 通知に表示するアプリ名(日本語)の設定を行います。
2 setDispNameEn 通知に表示するアプリ名(英語)の設定を行います。
3 setContent 各コンテンツの内容データの設定処理を行います。
4 setContentUri 各コンテンツの内容データURIの設定処理を行います。
5 setImageUri 画像ファイルURIの設定処理を行います。
6 setImageMime 画像ファイルのMIMEタイプの設定処理を行います。
7 setMediaUri メディアファイルURIの設定処理を行います。
8 setMediaMime メディアファイルのMIMEタイプの設定処理を行います。
9 setNotificationID 通知IDの設定処理を行います。
10 setCategoryID 通知カテゴリID(任意の固定データ)の設定処理を行います。
11 setIllumination LEDの鳴動設定処理を行います。
12 setVibration バイブレーションの鳴動設定処理を行います。
13 setBeep ビープ音の鳴動設定処理を行います。
14 setDuration 通知継続時間の設定処理を行います。
15 setDeviceID 対象デバイスIDの設定処理を行います。
16 setDeviceUID 固有ID(複数指定可)の設定処理を行います。
17 send その他の情報のintent送信処理を行います。
18 clear 設定値のクリアを行います。

メソッド詳細

setDispNameJa
boolean setDispNameJa(String nameJa)
通知に表示するアプリ名(日本語)の設定を行います。
引数
StringnameJa通知に表示するアプリ名(日本語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDispNameEn
boolean setDispNameEn(String nameEn)
通知に表示するアプリ名(英語)の設定を行います。
引数
StringnameEn通知に表示するアプリ名(英語)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setContent
boolean setContent(int dataNo, byte[] data)
各コンテンツの内容データの設定処理を行います。
引数
intdataNocontentの番号(1~7)
byte[]data各番号に対応する内容データ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setContentUri
boolean setContentUri(int dataNo, String uri)
各コンテンツの内容データURIの設定処理を行います。
引数
intdataNocontentの番号(1~7)
Stringuri各番号に対応する内容データ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setImageUri
boolean setImageUri(String imageUri)
画像ファイルURIの設定処理を行います。
引数
StringimageUri画像ファイルURI
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setImageMime
boolean setImageMime(String imageMime)
画像ファイルのMIMEタイプの設定処理を行います。
引数
StringimageMime画像のMIMEタイプ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setMediaUri
boolean setMediaUri(String mediaUri)
メディアファイルURIの設定処理を行います。
引数
StringmediaUriメディアファイルURI
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setMediaMime
boolean setMediaMime(String mediaMime)
メディアファイルのMIMEタイプの設定処理を行います。
引数
StringmediaMimeメディアファイルのMIMEタイプ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setNotificationID
boolean setNotificationID(int notificationID)
通知IDの設定処理を行います。
引数
intnotificationID通知ID(通知キャンセル時に使用する任意の番号)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setCategoryID
boolean setCategoryID(int categoryID)
通知カテゴリID(任意の固定データ)の設定処理を行います。
引数
intcategoryID通知カテゴリID(任意の固定データ)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setIllumination
boolean setIllumination(byte[] illumination)
LEDの鳴動設定処理を行います。
引数
Byte[]illuminationLED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setVibration
boolean setVibration(byte[] vibration)
バイブレーションの鳴動設定処理を行います。
引数
Byte[]vibrationバイブレーション鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setBeep
boolean setBeep(byte[] beep)
ビープ音の鳴動設定処理を行います。
引数
Byte[]beepビープ音鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDuration
boolean setDuration(byte[] Duration)
通知継続時間の設定処理を行います。
引数
Byte[]Duration通知継続時間
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceID
boolean setDeviceID(int deviceID)
対象デバイスIDの設定処理を行います。
引数
intdeviceID対象デバイスID
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDeviceUID
boolean setDeviceUID(int[] deviceUID)
固有ID(複数指定可)の設定処理を行います。
引数
int[]deviceUID固有ID(複数指定可)LED鳴動設定
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
send
int send()
その他の情報のintent送信処理を行います。
各設定メソッドで値が設定されていた場合は、設定値をintent情報に格納します。
引数
なし
戻り値
OK 正常終了
NG 異常終了
clear
void clear()
設定値のクリアを行います。send処理後に、設定を無効にしたい場合に使用してください。
引数
なし
戻り値
なし