java.lang.Object

com.opentok.Session


classe publique Session hérite de Objet

Représente une session OpenTok. Utilisez la méthode OpenTok.createSession(SessionProperties properties) méthode permettant de créer une session OpenTok. Utilisez la getSessionId() méthode de l'objet Session permettant d'obtenir l'identifiant de session.

Résumé de la méthode

Toutes les méthodes · Méthodes d'instance · Méthodes concrètes

Modificateur et type

Méthode

Description

String

generateToken()

Génère le jeton de la session.

String

generateToken(TokenOptions tokenOptions)

Crée un jeton permettant de se connecter à une session OpenTok.

int

getApiKey()

Renvoie la clé API OpenTok utilisée pour générer la session.

String

getApplicationId()

Récupère l'identifiant de l'application Vonage, le cas échéant.

SessionProperties

getProperties()

Renvoie les propriétés définissant la session.

String

getSessionId()

Renvoie l'identifiant de session, qui identifie de manière unique la session.

Méthodes héritées de la classe java.lang.Objet

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

Détails de la méthode

getApplicationId

public  Chaîne getApplicationId()

Récupère l'identifiant de l'application Vonage, le cas échéant.

Renvoie : : L'UUID de l'application Vonage sous forme de chaîne de caractères, ou null si vous utilisez une clé et un secret API OpenTok.

Depuis la version : : 4.15.0

getApiKey

public int getApiKey()

Renvoie la clé API OpenTok utilisée pour générer la session.

getSessionId

public  Chaîne getSessionId()

Renvoie l'identifiant de session, qui identifie de manière unique la session.

getProperties

public  Propriétés de session getProperties()

Renvoie les propriétés définissant la session. Ces propriétés sont les suivantes :

  • L'adresse IP indiquant la localisation.
  • Si les flux de la session seront transmis directement entre pairs ou via le serveur multimédia OpenTok.

generateToken

public  Chaîne generateToken() lance une exception OpenTokException

Génère le jeton pour la session. Le rôle est défini sur « éditeur », le jeton expire dans 24 heures et aucune donnée de connexion n'est fournie.

Retourne : : La chaîne de caractères du jeton.

Lancers : : OpenTokException

Voir aussi : : - generateToken(TokenOptions tokenOptions)

generateToken

public  Chaîne generateToken(TokenOptions tokenOptions) lance une exception OpenTokException

Crée un jeton permettant de se connecter à une session OpenTok. Pour qu'un utilisateur puisse s'authentifier lorsqu'il se connecte à une session OpenTok, il doit fournir un jeton d'authentification ainsi que la clé API.

Paramètres : : tokenOptions - Cet objet TokenOptions définit les options associées au jeton. Il s'agit notamment des éléments suivants :

- The role of the token (subscriber, publisher, or moderator)
- The expiration time of the token
- Connection data describing the end-user

Retourne : : La chaîne de caractères du jeton.

Lancers : : OpenTokException