メニュー

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?

TCDevice クラス リファレンス

Deprecation Notice

Please note that the Twilio Client iOS SDK is superseded by the newer Twilio Programmable Voice iOS SDK, which supports iOS 10 and uses Apple VoIP Services push notifications for signaling incoming calls. Please see our announcement for background information on this change and consult the Programmable Voice iOS SDK documentation for technical details

概要

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

TCDevice は Twilio クライアントの最初のエントリポイントです。iOS アプリケーションは、initWithCapabilityToken:delegate: メソッドを使って、Twilio サービスとやり取りするケイパビリティ トークンで TCDevice を初期化する必要があります。

ケイパビリティ トークンは、TCDevice が Twilio アプリケーションについて行う動作を指定した JSON Web Token (JWT)です。発信通話をかけられるか、トークンと TCDevice をどのくらいの期間有効にし、どのタイミングで更新を必要とするか、などです。詳細については、http://www.twilio.com/docs/client/capability-tokens を参照してください。

Tasks

セレクタ 概要 Type
state TCDevice の現在の状態です。 プロパティ
capabilities TCDevice の現在のケイパビリティです。“Device capability keys” によってキーが定義されます。 プロパティ
delegate TCDevice オブジェクトからイベントを受け取るデリゲートオブジェクトです。    プロパティ
incomingSoundEnabled 着信接続のイベント音の有無を示す BOOL です。 プロパティ
outgoingSoundEnabled 発信接続のイベント音の有無を示す BOOL です。 プロパティ
disconnectSoundEnabled 理由を問わず接続が終了した時のイベント音の有無を示す BOOL です。 プロパティ
–initWithCapabilityToken:delegate: 新しい TCDevice オブジェクトを初期化します。着信のケイパビリティが定義されている場合、デバイスは自動的に着信接続の待ち受けを開始します。 インスタンス メソッド
–listen TCDevice の着信接続の待ち受けを開始します。 インスタンス メソッド
–unlisten デバイスの着信接続の待ち受けを停止します。 このメソッドはたとえば、iOS アプリケーションを「サイレント」モードにするために使用できます。 インスタンス メソッド
– updateCapabilityToken: TCDevice のケイパビリティを更新します。 インスタンス メソッド
–connect:delegate: 発信の接続を作成します。 インスタンス メソッド
–disconnectAll このレシーバーに関連付けられたすべてのアクティブな接続を終了します。 インスタンス メソッド

プロパティ

capabilities

TCDevice の現在のケイパビリティです。“Device capability keys” によってキーが定義されます。

@property (nonatomic, readonly) NSDictionary *capabilities

解説

TCDevice の現在のケイパビリティです。“Device capability keys” によってキーが定義されます。


delegate

TCDevice オブジェクトからイベントを受け取るデリゲートオブジェクトです。   

@property (nonatomic, assign) id<TCDeviceDelegate> delegate

解説

TCDevice オブジェクトからイベントを受け取るデリゲートオブジェクトです。   


disconnectSoundEnabled

理由を問わず接続が終了した時のイベント音の有無を示す BOOL です。

@property (nonatomic) BOOL disconnectSoundEnabled

解説

理由を問わず接続が終了した時のイベント音の有無を示す BOOL です。

初期値は YES です。イベント音の詳細については、Twilio クライアント iOS 利用ガイドを参照してください。


incomingSoundEnabled

着信接続のイベント音の有無を示す BOOL です。

@property (nonatomic) BOOL incomingSoundEnabled

解説

着信接続のイベント音の有無を示す BOOL です。

初期値は YES です。イベント音の詳細については、Twilio クライアント iOS 利用ガイドを参照してください。


outgoingSoundEnabled

発信接続のイベント音の有無を示す BOOL です。

@property (nonatomic) BOOL outgoingSoundEnabled

解説

発信接続のイベント音の有無を示す BOOL です。

初期値は YES です。イベント音の詳細については、Twilio クライアント iOS 利用ガイドを参照してください。


state

TCDevice の現在の状態です。

@property (nonatomic, readonly) TCDeviceState state

解説

TCDevice の現在の状態です。

状態変化が起こると TCDeviceDelegate で関連するメソッドが呼び出されます。これにはすべての NSError の発生が含まれます。

インスタンス メソッド

connect:delegate:

発信の接続を作成します。

- (TCConnection *)connect:(NSDictionary *)parameters delegate:(id<TCConnectionDelegate>)delegate

パラメーター
名前 概要
parameters 発信接続で Twilio アプリケーションに渡されるパラメーターを含んだ、オプションのディクショナリです。これらのパラメーターは、ケイパビリティ トークンの中のすべてのパラメーターとマージされます(例:capabilities プロパティに対して TCDeviceCapabilityApplicationParametersKey で取得したディクショナリ)。 2 つのディクショナリでキーの衝突が発生した場合、TCDeviceCapabilityApplicationParametersKey ディクショナリの値が優先されます。
delegate TCConnection オブジェクトの状態を更新した際コールバックを受けるオプションの代表オブジェクト   
戻り値

新しい発信接続を表す TCConnection オブジェクト。戻り値が nil の場合は、接続を初期化できません。

解説

発信の接続を作成します。


disconnectAll

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

- (void)disconnectAll

解説

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

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


initWithCapabilityToken:delegate:

新しい TCDevice オブジェクトを初期化します。着信のケイパビリティが定義されている場合、デバイスは自動的に着信接続の待ち受けを開始します。

- (id)initWithCapabilityToken:(NSString *)capabilityToken delegate:(id<TCDeviceDelegate>)delegate

パラメーター
名前 概要
capabilityToken TCDevice が使用できる機能を定義した署名付きの JSON Web Token (JWT)です。Twilio の Helper ライブラリを使って生成することができます。Helper ライブラリは SDK に同梱されているか、または http://www.twilio.com で入手できます。ケイパビリティは、着信接続の待ち受けを開始したり、発信接続を確立したりするために使用されるデフォルトのパラメーターを提供する際に使われます。詳細については、http://www.twilio.com/docs/client/capability-tokens を参照してください。
delegate TCDevice オブジェクトからイベントを受け取るデリゲートオブジェクトです。   
戻り値

初期化されたレシーバー。

解説

新しい TCDevice オブジェクトを初期化します。着信のケイパビリティが定義されている場合、デバイスは自動的に着信接続の待ち受けを開始します。

参考

– updateCapabilityToken:


listen

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

- (void)listen

解説

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

トークンが許可した場合、TCDevice は自動的に受信接続を initWithCapabilityToken:delegate: もしくは updateCapabilityToken: へのメソッドコール上でリッスンします。

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


unlisten

デバイスの着信接続の待ち受けを停止します。 このメソッドはたとえば、iOS アプリケーションを「サイレント」モードにするために使用できます。

- (void)unlisten

解説

デバイスの着信接続の待ち受けを停止します。 このメソッドはたとえば、iOS アプリケーションを「サイレント」モードにするために使用できます。

アンリッスンへの前回のコールか、TCDevice が着信機能が許可されていないため、TCDevice が同様に現在リッスンしていない場合、このメソッドは何もしません。


updateCapabilityToken:

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

- (void)updateCapabilityToken:(NSString *)capabilityToken

パラメーター
名前 概要
capabilityToken TCDevice が利用できるケイパビリティ トークンを定義する署名付き JWT。 詳細については、http://www.twilio.com/docs/client/capability-tokens を参照してください。
解説

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

定義された機能の有効期限が切れている場合、何か事情があるかもしれません。たとえば、 機能の有効期限が切れているため TCDeviceTCDeviceIncomingStateOffline の状態になることができるかもしれません。これらのケースでは、 機能を更新する必要があります。デバイスが現在の着信接続をリッスンしている場合は、これらの機能の更新を使用して、(許されるなら)リスニング·プロセスを再起動します。

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.