java.lang.Object

com.opentok.TokenOptions.Builder

Classe de contenção: : Opções de tokens


classe pública estática TokenOptions.Builder estende Objeto

Use esta classe para criar um objeto TokenOptions.

Veja também: : - TokenOptions

Resumo do Construtor

Construtores

Construtor

Descrição

Builder()

Resumo do método

Todos os métodosMétodos de instânciaMétodos concretos

Modificador e Tipo

Método

Descrição

TokenOptions

build()

Cria o objeto TokenOptions.

TokenOptions.Builder

data(String data)

Uma string contendo metadados de conexão que descrevem o usuário final.

TokenOptions.Builder

expireTime(long expireTime)

Define o prazo de validade do token.

TokenOptions.Builder

initialLayoutClassList(List<String> initialLayoutClassList)

Uma lista de nomes de classes (cadeias de caracteres) a serem usadas como classes de layout iniciais para fluxos publicados pelo cliente.

TokenOptions.Builder

role(Role role)

Define a função do token.

TokenOptions.Builder

useLegacyT1Token()

Use este método para gerar um token T1 legado em vez de um JWT.

Métodos herdados da classe java.lang.Objeto

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

Detalhes do construtor

Construtor

public Builder()

Detalhes do método

função

público  TokenOptions.Builder função(Função função)

Define a função do token. Cada função define um conjunto de permissões concedidas ao token.

Parâmetros: : role - A função do token. Os valores válidos estão definidos na classe 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/).

expireTime

público  TokenOptions.Builder expireTime(long expireTime)

Define o prazo de validade do token.

Parâmetros: : expireTime - O tempo de validade, em segundos desde a época UNIX. Passe o valor 0 para usar o tempo de validade padrão de 24 horas após a hora de criação do token. O tempo máximo de validade é de 30 dias após a hora de criação.

dados

público  TokenOptions.Builder dados(String dados) lança InvalidArgumentException

Uma string contendo metadados de conexão que descrevem o usuário final. Por exemplo, você pode passar o ID do usuário, o nome ou outros dados que descrevam o usuário final. O comprimento da string é limitado a 1.000 caracteres. Esses dados não podem ser atualizados depois de definidos.

Parâmetros: : data - Os metadados da conexão.

Arremessos: : InvalidArgumentException

lista de classes de layout inicial

público  TokenOptions.Builder initialLayoutClassList(Lista<String> initialLayoutClassList)

Uma lista de nomes de classes (cadeias de caracteres) a serem usadas como classes de layout iniciais para os streams publicados pelo cliente. As classes de layout são usadas para personalizar o layout dos vídeos em transmissão ao vivo transmissões e compostos arquivos.

Parâmetros: : initialLayoutClassList - A lista inicial de classes de layout.

useLegacyT1Token

público  TokenOptions.Builder useLegacyT1Token()

Use este método para gerar um token T1 legado em vez de um JWT.

Retorna: : Este construtor.

Desde: : 4.15.0

construir

público  Opções de tokens build()

Cria o objeto TokenOptions.

Retorna: : O objeto TokenOptions.