Class Session

constructor

• new Session(BidiConnection): Session

• Create a session.

  Parameters

  • BidiConnection: BiDi

    BiDi Connection

  Returns Session

_capabilities

_contexts

_events

_ws

status

• get status(): Promise<SessionStatusResult>

• Get status of session.

  Returns Promise<SessionStatusResult>

  Promise object represents the session status.

end

• end(): Promise<void>

• Ends the active session.

  Sends a command to the WebSocket to end the current session through the session.end method.

  Returns Promise<void>

  Promise that resolves if the session ends successfully, rejects if the WebSocket fails to send the command.

  Async

new

• new(capabilities): Promise<SessionNewResult>

• Create a new session

  Parameters

  • capabilities: CapabilitiesRequest

    The capabilities that the new session should have.

  Returns Promise<SessionNewResult>

  Promise object represents the newly created session.

  Throws

  When unable to create a session.

subscribe

• subscribe(subscriptionRequest): Promise<void>

• Subscribes to specified events.

  Parameters

  • subscriptionRequest: SubscriptionRequest

  Returns Promise<void>

  Promise representing sending command for subscription.

unsubscribe

• unsubscribe(unsubscriptionType): Promise<void>

• Unsubscribes from specified events.

  Parameters

  • unsubscriptionType: SubscriptionRequest

  Returns Promise<void>

  Promise representing sending command for unsubscription.