java.lang.Object

com.opentok.TokenOptions.Builder

包含クラス: : TokenOptions


public static class TokenOptions.Builder extends 目的

このクラスを使用して、TokenOptions オブジェクトを作成します。

関連項目: : - TokenOptions

コンストラクタの概要

コンストラクタ

コンストラクタ

説明

Builder()

方法の概要

すべてのメソッド インスタンスメソッド 具体的なメソッド

修飾子と型

方法

説明

TokenOptions

build()

TokenOptions オブジェクトを作成します。

TokenOptions.Builder

data(String data)

エンドユーザーに関する接続メタデータを記述した文字列。

TokenOptions.Builder

expireTime(long expireTime)

トークンの有効期限を設定します。

TokenOptions.Builder

initialLayoutClassList(List<String> initialLayoutClassList)

クライアントによって公開されるストリームの初期レイアウトクラスとして 使用されるクラス名(文字列)の一覧。

TokenOptions.Builder

role(Role role)

トークンの役割を設定します。

TokenOptions.Builder

useLegacyT1Token()

JWTの代わりにレガシーT1トークンを生成するには、この方法を使用してください。

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

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

コンストラクタの詳細

ビルダー

public Builder()

メソッドの詳細

役割

public TokenOptions.Builder role(役割 役割)

トークンのロールを設定します。各ロールは、トークンに付与される一連の権限を定義します。

パラメータ: : role - トークンの役割。有効な値は Role クラスで定義されています:

- `SUBSCRIBER` — A subscriber can only subscribe to streams.
- `PUBLISHER` — A publisher can publish streams, subscribe to
  streams, and signal. (This is the default value if you do not specify a role.)
- `MODERATOR` — In addition to the privileges granted to a
  publisher, a moderator can perform moderation functions, such as forcing clients to
  disconnect, to stop publishing streams, or to mute audio in published streams. See the
  [Moderation developer guide](https://tokbox.com/developer/guides/moderation/).

有効期限

public TokenOptions.Builder expireTime(long expireTime)

トークンの有効期限を設定します。

パラメータ: : expireTime - 有効期限(UNIXエポックからの経過秒数)。0 を指定すると、 トークン作成時刻から 24 時間というデフォルトの有効期限が適用されます。有効期限の 最大値は、作成時刻から 30 日後です。

データ

public TokenOptions.Builder data(ストリング data) throws InvalidArgumentException

エンドユーザーに関する接続メタデータを含む文字列です。たとえば、 ユーザーID、名前、またはエンドユーザーに関するその他のデータを渡すことができます。この 文字列の長さは1000文字までに制限されています。一度設定されたこのデータは更新できません。

パラメータ: : data - 接続メタデータ。

投球: : InvalidArgumentException

initialLayoutClassList

public TokenOptions.Builder initialLayoutClassList(一覧<ストリング> initialLayoutClassList)

クライアントによって公開されるストリームの初期レイアウトクラスとして 使用されるクラス名(文字列)のリスト。レイアウトクラスは、 動画のレイアウトをカスタマイズするために使用されます。 ライブ配信 放送 そして 作成済み アーカイブ.

パラメータ: : initialLayoutClassList - 初期のレイアウトクラス一覧。

useLegacyT1Token

public TokenOptions.Builder useLegacyT1Token()

JWTの代わりにレガシーT1トークンを生成するには、この方法を使用してください。

戻り値: : このビルダー。

バージョン: : 4.15.0

ビルド

public TokenOptions build()

TokenOptions オブジェクトを作成します。

戻り値: : TokenOptions オブジェクト。