メニュー

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Device クラス リファレンス

Deprecation Notice

The Twilio Client SDK for Android has been deprecated and replaced by Twilio's new Programmable Voice SDK.

The Programmable Voice SDK offers many improvements over the Twilio Client SDK, including greater stability, improved backgrounding, and built-in support for push notifications for incoming calls.

If you're just getting started with a Twilio mobile application for voice calling, we recommend you use the Programmable Voice SDK. If you're already using the Twilio Client SDK, you should plan to upgrade to the Programmable Voice SDK as soon as you're able.

Get started with the new Programmable Voice SDK by checking out the quickstart for Programmable Voice SDK for Android on Github.

概要

  • パッケージ : com.twilio.client
  • 親クラス : Object
  • 実装されたインターフェイス : Parcelable

Device のインスタンスは、Twilio サービスにどのようにインターフェイス接続するかの情報を持つオブジェクトです。

Device は Twilio クライアントの最初のエントリ ポイントです。 Android アプリケーションは Twilio.createDevice() ファクトリ メソッドを使って、Twilio サービスとやり取りするケイパビリティ トークンで Device を初期化する必要があります。

ケイパビリティ トークンは、Device が Twilio アプリケーションについて行う動作を指定した JSON Web Token (JWT) です。発信通話をかけられるか、トークンと Device をどのくらいの期間有効にし、どのタイミングで更新を必要とするか、などです。

詳細については、 http://www.twilio.com/docs/client/capability-tokens を参照してください。

ネストされたクラス

Tasks

名前 概要 Type
EXTRA_DEVICE Device オブジェクトを指すインテントの extras データへのキーです。 フィールド
EXTRA_CONNECTION Connection オブジェクトを指すインテントの extras データへのキーです。 フィールド
release Deviceのシャット ダウンと開放を行います。 インスタンス メソッド
listen 着信の接続の待ち受けを開始します。 インスタンス メソッド
unlisten 着信の接続の待ち受けを終了します。 インスタンス メソッド
getCapabilityToken Twilio.createDevice()に渡されたケイパビリティ トークンを取得します。 インスタンス メソッド
updateCapabilityToken Device のケイパビリティを更新します。 インスタンス メソッド
connect Device のケイパビリティ トークンに指定されたTwilio アプリケーションへの新しい接続を作成します。 インスタンス メソッド
disconnectAll この Device に関連付けられたすべてのアクティブな接続を終了します。 インスタンス メソッド
getCapabilities Device の現在のケイパビリティです。 インスタンス メソッド
getState デバイスの現在の状態を取得します。 インスタンス メソッド
setDeviceListener デバイス イベントに応答するための新しい DeviceListener オブジェクトを設定します。 インスタンス メソッド
setIncomingIntent 着信の接続を受けた時に送信される PendingIntent を設定します。 インスタンス メソッド
setIncomingSoundEnabled 着信接続のイベント音の有無を設定します。 インスタンス メソッド
isIncomingSoundEnabled 着信接続のイベント音の有無を返します。 インスタンス メソッド
setOutgoingSoundEnabled 発信接続のイベント音の有無を設定します。 インスタンス メソッド
isOutgoingSoundEnabled 発信接続のイベント音の有無を返します。 インスタンス メソッド
setDisconnectSoundEnabled 接続が正常終了または異常終了した時のイベント音の有無を設定します。 インスタンス メソッド
isDisconnectSoundEnabled 接続が正常終了または異常終了した時のイベント音の有無を返します。 インスタンス メソッド

フィールド

EXTRA_DEVICE

Device オブジェクトを指すインテントの extras データへのキーです。

EXTRA_CONNECTION

Connection オブジェクトを指すインテントの extras データへのキーです。

メソッド

void release()

Deviceのシャット ダウンと開放を行います。

ガベージ コレクションの発生タイミングが未知であるため、このメソッドはすべての接続を終了し、ただちにリソースを開放します。

戻り値

なし


void listen()

着信の接続の待ち受けを開始します。

トークンが許可する場合、Device は自動的に Twilio.createDevice() または .updateCapabilityToken() が呼び出されるのを待ち受けます。

このメソッドは前回 .unlisten() が呼び出された場合のみ、呼び出す必要があります。

戻り値

なし


void unlisten()

着信の接続の待ち受けを終了します。

このメソッドはたとえば、Android アプリケーションを「サイレント」モードにするために使用できます。

前回 .unlisten() が実行されたため Device が現在待ち受け状態でないか、または Device が着信のケイパビリティを許可されていない場合、このメソッドは何もしません。

戻り値

なし


String getCapabilityToken()

Twilio.createDevice()に渡されたケイパビリティ トークンを取得します。

戻り値

空でないケイパビリティ トークン文字列


void updateCapabilityToken(String inCapabilityToken)

Device のケイパビリティを更新します。

定義されたケイパビリティが期限切れの場合、または変更を必要とする場合があります。 たとえば、ケイパビリティが期限切れのために Device が State に入ることがあります。 この場合、ケイパビリティを更新する必要があります。 現在デバイスが着信の接続を待ち受けている場合は、この更新されたケイパビリティを使用して待ち受けプロセス (許可される場合) を再び開始します。

ケイパビリティ トークンの更新による既存の接続への影響はありません。

パラメーター
名前 概要
inCapabilityToken 新しいケイパビリティ トークン文字列
戻り値

なし


Connection connect(Map<> inParameters, ConnectionListener inListener)

Device のケイパビリティ トークンに指定されたTwilio アプリケーションへの新しい接続を作成します。

パラメーターは修正されずにアプリケーションに渡されます。

パラメーター
名前 概要
inParameters 発信接続で Twilio アプリケーションに渡されるパラメーターを含んだ、オプションの Map です。 これらのパラメーターは、ケイパビリティ トークンの中のすべてのパラメーターとマージされます。 2 つの Map でキーの衝突が発生した場合、@{link Capability Map からの値が優先されます。
inListener 接続イベントに応答する ConnectionListener のデリゲート オブジェクトです。
戻り値

新しい Connection ハンドル、または接続の作成に失敗した場合は null


void disconnectAll()

この Device に関連付けられたすべてのアクティブな接続を終了します。

現在アクティブなすべての着信および発信の接続を終了するための、便利なルーチンです。pending 状態の着信接続も含まれます。

戻り値

なし


Map<> getCapabilities()

Device の現在のケイパビリティです。

キーは Capability の enum で定義されます。

戻り値

ケイパビリティのキー/値のマッピング

State getState()

デバイスの現在の状態を取得します。

戻り値

State の enum 値で表されるデバイスの状態


void setDeviceListener(DeviceListener inListener)

デバイス イベントに応答するための新しい DeviceListener オブジェクトを設定します。

パラメーター
名前 概要
inListener DeviceListenerまたは null
戻り値

なし


void setIncomingIntent(PendingIntent inIntent)

着信の接続を受けた時に送信される PendingIntent を設定します。

渡される PendingIntent は、Activity、Service、または BroadcastReceiver への参照です。 コンポーネントがインテントを受け取る際に、新しい接続の受け入れ、無視、拒否のいずれかを選択する必要があります。

アプリケーションがインテントを受信したらインテントに含まれる extras から着信の接続に関連する Device オブジェクトおよび Connection オブジェクトを取得します。この時、キーとして Device および Deviceを使用します。これらはいずれも Parcelable インターフェイスを実装します。

この時、 ConnectionListener に適切な Connection を割り当ててイベントに応答する必要があります。

pending 状態の着信接続は、別の接続がアクティブの間でも、いつでも受け取ることができます。 このインテントは各接続で 1 回呼び出されます。ユーザーのコードはこの状況に適切に対処する必要があります。 現在アクティブな他の接続がなければ、pending 状態の接続を 1 つ受け付けることができます。これ以外のすべての pending 状態の着信接続は、アクティブな接続が終了するまではライブラリによって自動的に拒否されます。

パラメーター
名前 概要
inIntent 着信の接続を受けた時に呼び出す PendingIntent です。
戻り値

なし


void setIncomingSoundEnabled(boolean enabled)

着信接続のイベント音の有無を設定します。

デフォルトでは、.isIncomingSoundEnabled()true に設定されています。 イベント音の詳細については、Twilio クライアント Android の クイックスタート ガイドを参照してください。

パラメーター
名前 概要
enabled true を指定すると有効に、false を指定すると無効になります
戻り値

なし


boolean isIncomingSoundEnabled()

着信接続のイベント音の有無を返します。

初期値は true です。 イベント音の詳細については、Twilio クライアント Android の クイックスタート ガイドを参照してください。

戻り値

なし


void setOutgoingSoundEnabled(boolean enabled)

発信接続のイベント音の有無を設定します。

デフォルトでは、.isOutgoingSoundEnabled()true に設定されています。 イベント音の詳細については、Twilio クライアント Android の クイックスタート ガイドを参照してください。

パラメーター
名前 概要
enabled true を指定すると有効に、false を指定すると無効になります
戻り値

なし


boolean isOutgoingSoundEnabled()

発信接続のイベント音の有無を返します。

初期値は true です。 イベント音の詳細については、Twilio クライアント Android の クイックスタート ガイドを参照してください。

戻り値

なし


void setDisconnectSoundEnabled(boolean enabled)

接続が正常終了または異常終了した時のイベント音の有無を設定します。

接続終了のイベント音は、接続が無視または拒否された場合は再生されません。

デフォルトでは、.isDisconnectSoundEnabled()true に設定されています。 イベント音の詳細については、Twilio クライアント Android の クイックスタート ガイドを参照してください。

パラメーター
名前 概要
enabled true を指定すると有効に、false を指定すると無効になります

戻り値

なし


boolean isDisconnectSoundEnabled()

接続が正常終了または異常終了した時のイベント音の有無を返します。

接続終了のイベント音は、接続が無視または拒否された場合は再生されません。

初期値は true です。 イベント音の詳細については、Twilio クライアント Android の クイックスタート ガイドを参照してください。

戻り値

なし

Rate this page:

ヘルプが必要ですか?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.