com.twilio.jwt.accesstoken

Class VideoGrant

java.lang.Object

com.twilio.jwt.accesstoken.VideoGrant

All Implemented Interfaces:

Grant

public class VideoGrant
extends Object
implements Grant

Grant used to access Twilio Video.

For more information see: https://www.twilio.com/docs/api/rest/access-tokens

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	VideoGrant.Payload

Constructor Summary

Constructors

Constructor and Description
VideoGrant()

Method Summary

Modifier and Type	Method and Description
String	getConfigurationProfileSid() Deprecated. use getRoom() instead.
String	getGrantKey() The key for the grant.
Object	getPayload() The payload for this grant.
String	getRoom() Get the room configured in this grant.
VideoGrant	setConfigurationProfileSid(String configurationProfileSid) Deprecated. use setRoom(String) instead.
VideoGrant	setRoom(String roomSidOrName) Set the room to grant access to

Methods inherited from class java.lang.Object

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

Constructor Detail

VideoGrant

public VideoGrant()

Method Detail

getConfigurationProfileSid

@Deprecated
public String getConfigurationProfileSid()

Deprecated. use getRoom() instead.

Get the configuration profile sid of this grant.

Returns:

The configuration profile sid or null if not set.

setConfigurationProfileSid

@Deprecated
public VideoGrant setConfigurationProfileSid(String configurationProfileSid)

Deprecated. use setRoom(String) instead.

Set the configuration profile sid on the grant.

Parameters:

configurationProfileSid - configuration profile sid

Returns:

updated VideoGrant instance

getRoom

public String getRoom()

Get the room configured in this grant.

Returns:

The room name or sid or null if not set.

setRoom

public VideoGrant setRoom(String roomSidOrName)

Set the room to grant access to

Parameters:

roomSidOrName - a room sid or name

Returns:

updated VideoGrant instance

getGrantKey

public String getGrantKey()

Description copied from interface: Grant

The key for the grant.

Specified by:

getGrantKey in interface Grant

Returns:

The key for the grant.

getPayload

public Object getPayload()

Description copied from interface: Grant

The payload for this grant.

The payload allows us to decouple the user API from how the grant is structured.

Specified by:

getPayload in interface Grant

Returns:

The payload for this grant.