Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Session

Hierarchy

  • Session

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

properties

properties: SessionProperties

sessionId

sessionId: string

Methods

generateToken

  • generateToken(tokenOptions?: TokenOptions): Promise<string>

  • Gets a new token associated to Session object. This translates into a new request to OpenVidu Server

    Parameters

    Returns Promise<string>

    A Promise that is resolved to the token if success and rejected with an Error object if not (due to a 400 (Bad Request) error in OpenVidu Server)

getSessionId

  • getSessionId(): Promise<string>

  • Gets the unique identifier of the Session. This translates into a new request to OpenVidu Server if this Session has no sessionId yet or simply returns the existing value if it has already been retrieved

    Returns Promise<string>

    A Promise that is resolved to the sessionId if success and rejected with an Error object if not (due to a 400 (Bad Request) error in OpenVidu Server)

Generated using TypeDoc