Package com.vonage.client.video

Class TokenOptions

java.lang.Object

com.vonage.client.video.TokenOptions

public class TokenOptions
extends Object

Defines values for the options parameter of the VideoClient.generateToken(String sessionId, TokenOptions tokenOptions) method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TokenOptions.Builder	Use this class to create a TokenOptions object.

Method Summary

Modifier and Type	Method	Description
protected void	addClaims(com.vonage.jwt.Jwt.Builder jwt)
static TokenOptions.Builder	builder()	Entry point for constructing an instance of TokenOptions.
String	getData()	Returns the connection metadata assigned to the token.
Duration	getExpiryLength()	Returns the time-to-live for the JWT.
List<String>	getInitialLayoutClassList()	Returns the initial layout class list for streams published by the client using this token.
Role	getRole()	Returns the role assigned to the token.

Methods inherited from class java.lang.Object

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

Method Details

addClaims

protected void addClaims(com.vonage.jwt.Jwt.Builder jwt)

getRole

public Role getRole()

Returns the role assigned to the token.

Returns:

The role, as an enum.

See Also:

• TokenOptions.Builder.role(Role)

getExpiryLength

public Duration getExpiryLength()

Returns the time-to-live for the JWT.

Returns:

The TTL duration.

See Also:

• TokenOptions.Builder.expiryLength(Duration)

getData

public String getData()

Returns the connection metadata assigned to the token.

Returns:

The connection data, as a string.

See Also:

• TokenOptions.Builder.data(String)

getInitialLayoutClassList

public List<String> getInitialLayoutClassList()

Returns the initial layout class list for streams published by the client using this token.

Returns:

The initial layout classes, as a List of strings.

See Also:

• TokenOptions.Builder.initialLayoutClassList(List)

builder

public static TokenOptions.Builder builder()

Entry point for constructing an instance of TokenOptions.

Returns:

A new Builder.