ISessionInfo interface

Member of ININ.Addins.IC Since 2016 R1 API Version 1

Represents the state of the application's session to Interaction Center.

Members

connected :boolean

Read-only Since 2016 R1 API Version 1

Represents whether the application is connected to Interaction Center or not.

host :string

Read-only Since 2016 R1 API Version 1

When the application is connected to Interaction Center, represents the Session Manager host the application is connected to. This property will be null when the application is not connected.

icServer :string

Read-only Since 2016 R1 API Version 1

When the application is connected to Interaction Center, represents the Interaction Center server name the application is connected to. This property will be null when the application is not connected.

station :ININ.Addins.IC.IStationInfo

Read-only Since 2018 R3 API Version 1

When the application is connected to Interaction Center, represents the station of the user the application that is connected. This property will be null when the application is not connected.

userId :string

Read-only Since 2016 R1 API Version 1

When the application is connected to Interaction Center, represents the identifier of the user that is connected. This property will be null when the application is not connected.

Methods

off(key[, handler]) :ININ.Addins.IEventHandler

Since 2016 R1 API Version 1

Unbinds the optionally specified handler from the event key.

Inherited from ININ.Addins.IEventHandler#off

Parameters

Name Type Description
key String

The event key.
handler function Optional

The callback handler.

Returns

This ININ.Addins.IEventHandler instance.

Type
ININ.Addins.IEventHandler

on(key, handler) :ININ.Addins.IEventHandler

Since 2016 R1 API Version 1

Binds the specified event key to the callback that can be emitted 1 or more times.

Inherited from ININ.Addins.IEventHandler#on

Parameters

Name Type Description
key String

The event key.
handler function

The callback handler.

Returns

This ININ.Addins.IEventHandler instance.

Type
ININ.Addins.IEventHandler

once(key, handler) :ININ.Addins.IEventHandler

Since 2016 R1 API Version 1

Binds the specified event key to the callback that can be emitted only once, then removed.

Inherited from ININ.Addins.IEventHandler#once

Parameters

Name Type Description
key String

The event key.
handler function

The callback handler.

Returns

This ININ.Addins.IEventHandler instance.

Type
ININ.Addins.IEventHandler

Events

changed

Since 2016 R1 API Version 1

The state of the session has changed.

Parameters

Name Type Description
sessionInfo ININ.Addins.IC.ISessionInfo

The ININ.Addins.IC.ISessionInfo instance.

connected

Since 2016 R1 API Version 1

The application is now connected to Interaction Center.

Parameters

Name Type Description
sessionInfo ININ.Addins.IC.ISessionInfo

The ININ.Addins.IC.ISessionInfo instance.

disconnected

Since 2016 R1 API Version 1

The application is now disconnected from Interaction Center.

Parameters

Name Type Description
sessionInfo ININ.Addins.IC.ISessionInfo

The ININ.Addins.IC.ISessionInfo instance.