Global

Members

<private> _isLoggedIn :Boolean

Keeps information about Authentication Service instance status (started or not)

Type:
  • Boolean

<private> _provider :AvayaRecordingClient.Providers.Program

Custom implementation provider

Type:
  • AvayaRecordingClient.Providers.Program

<private> _provider :AvayaRecordingClient.Providers.Tenant

Custom implementation provider

Type:
  • AvayaRecordingClient.Providers.Tenant

<private> _provider :AvayaRecordingClient.Providers.Authentication

Custom implementation provider

Type:
  • AvayaRecordingClient.Providers.Authentication

<private> _provider :AvayaRecordingClient.Providers.ChatClientProvider

Custom implementation provider

Type:
  • AvayaRecordingClient.Providers.ChatClientProvider

<private> _provider :AvayaRecordingClient.Providers.Reports.ReportsClientProvider

Custom implementation provider

Type:
  • AvayaRecordingClient.Providers.Reports.ReportsClientProvider

<private> _provider :AvayaRecordingClient.Providers.SystemSettings

Custom implementation provider

Type:
  • AvayaRecordingClient.Providers.SystemSettings

authenticationService :AvayaRecordingClient.Services.AuthenticationService

AuthenticationService service instance. Get\refresh auth token from UPS(ESG) server

Type:

authorizationUrl :string

UPS URL for get auth token for ACSR

Type:
  • string

authServer :AvayaRecordingClient.Config.ServerInfo

UPS authorization server

Type:

categoriesUrl :string

Category base URL

Type:
  • string

category :string

Filter by the category name to which the program the program belongs. The name can be partial.

Type:
  • string

category :string

Filter programs by category.

Type:
  • string

chatService :AvayaRecordingClient.Services.ChatService

ChatService service instance. IM sessions support

Type:

chatTimestamp :string

Only include messages which arrived after this timestamp (milliseconds since epoch GMT).

Type:
  • string

clientConfig :AvayaRecordingClient.Config.ClientConfig

Config object to pass during JSC SDK Recording package initialization

Type:
Default Value:
  • {Object}

count :number

Number of results to return Defaults to 20

Type:
  • number

count :string

Number of results to return. Defaults to 20

Type:
  • string

count :number

Number of results to return Defaults to 20

Type:
  • number

deleteResources :string

Defaults to true. If true, media associated with the program will be deleted in addition to the Program

Type:
  • string

dnAddress :string

Filter results to only views where the DN used for playback had an address containing this string

Type:
  • string

dnAddress :string

Filter results to only views where the DN used for playback had an address containing this string

Type:
  • string

dnid :string

Id of the Distribution Node used for playback

Type:
  • string

dnId :number

Id of the Distribution Node used for report playback

Type:
  • number

dnName :string

Filter results to only views where the DN used for playback had a name containing this string

Type:
  • string

dnName :string

Filter results to only views where the DN used for playback had a name containing this string

Type:
  • string

endDate :string

Filter results to only show views that ended before this time. Ignored if a range is specified.

Type:
  • string

endDate :number

Filter results to only show views that ended before this time. Ignored if a range is specified.

Type:
  • number

errors :Array.<string>

Returns an object contained errors

Type:
  • Array.<string>

host :string

Server hostname

Type:
  • string

isSecure :boolean

HTTP or HTTPS

Type:
  • boolean

logger :AvayaRecordingClient.Config.Logger

Optional custom logger implementation class

Type:
Default Value:
  • window.console

logger :AvayaRecordingClient.Config.Logger

Custom logger

Type:

moderatorPin :string

Moderator pin for the program if the user is not the conference owner

Type:
  • string

offset :number

Paging offset. Defaults to 0

Type:
  • number

offset :number

Paging offset. Defaults to 0

Type:
  • number

offset :string

Paging offset. Defaults to 0

Type:
  • string

onlyDeleted :boolean

Only include deleted programs (recycle bin) in results. Defaults to false.

Type:
  • boolean

orderBy :string

Sort order.

Type:
  • string

orderBy2 :string

Second sort order. "orderBy" must be present if using this field.

Type:
  • string

ownerId :string

Filter programs by user.

Type:
  • string

ownerName :string

Filter by the name of the owner of the program. Only tenant administrator and administrators can specify an owner name other than their own.
Defaults to the name of the user whose credentials were used to access the API.

Type:
  • string

pagedList :AvayaRecordingClient.Services.ProgramService.PagedList

Returns an array of Programs in case of success

Type:

permanent :string

Defaults to false. If false, and the program is a recording, the recording is place in the recycle bin. Otherwise it is permanently deleted.

Type:
  • string

port :number|string

Server port

Type:
  • number | string

programName :string

Filter results to only programs whose name contain this string.

Type:
  • string

programService :AvayaRecordingClient.Services.ProgramService

ProgramService service instance. All related to Programs data: view, fetch, edit e t c

Type:

programsUrl :string

Programs base URL

Type:
  • string

query :string

Search query. Matches:name, description

Type:
  • string

range :string

Filter results to only show views in the speicfied time range. Overrides startDate and endDate (below).
Must be one of the following values:
LAST_DAY,
LAST_WEEK,
LAST_MONTH,
LAST_THREE_MONTHS,
LAST_SIX_MONTHS,
LAST_YEAR,
ALL

Type:
  • string

range :string

Filter results to only show views in the speicfied time range. Overrides startDate and endDate (below).
Must be one of the following values:
LAST_DAY,
LAST_WEEK,
LAST_MONTH,
LAST_THREE_MONTHS,
LAST_SIX_MONTHS,
LAST_YEAR,
ALL

Type:
  • string

reason :string|number

Type:
  • string | number

reportService :AvayaRecordingClient.Services.ReportService

Reports service instance

Type:
  • AvayaRecordingClient.Services.ReportService

reportsUrl :string

Reports base URL

Type:
  • string

resources :AvayaRecordingClient.Config.ServerInfo.Resources|AvayaRecordingClient.Config.Resources.AuthorizationResources

resources

Type:

response :Object

Returns response object in case of success

Type:
  • Object

returnValue :OK|Error

Returns response code

Type:
  • OK | Error

returnValue :OK|Error

Returns response code

Type:
  • OK | Error

returnValue :string

Type:
  • string

sender :string

Display Name for sender

Type:
  • string

serverInfo :AvayaRecordingClient.Config.ServerInfo

server connection data

Type:

serviceServer :AvayaRecordingClient.Config.ServerInfo

ACSR server

Type:

startDate :string

Filter results to only show views that started after this time. Ignored if a range is specifed.

Type:
  • string

startDate :number

Filter results to only show views that started after this time. Ignored if a range is specifed.

Type:
  • number

success :boolean

Returns true if validation succeeded

Type:
  • boolean

systemSettingsService :AvayaRecordingClient.Services.SystemSettingsService

SystemSettings service instance

Type:

templatesUrl :string

Template base URL

Type:
  • string

tenantId :string

Filter programs by tenant.

Type:
  • string

tenantId :string

Filter programs by tenant. This parameter is implicit in the authentication token. A tenant other than that of the authenticated user may be specified, in which case results will be limited to public recordings within that tenant.

Type:
  • string

tenantId :string

Filter programs by tenant. This parameter is implicit in the authentication token. A tenant other than that of the authenticated user may be specified, in which case results will be limited to public recordings within that tenant.

Type:
  • string

tenantId :string

Filter programs by tenant. This parameter is implicit in the authentication token. A tenant other than that of the authenticated user may be specified, in which case results will be limited to public recordings within that tenant.

Type:
  • string

tenantId :string

Filter programs by tenant. This parameter is implicit in the authentication token. A tenant other than that of the authenticated user may be specified, in which case results will be limited to public recordings within that tenant.

Type:
  • string

tenantService :AvayaRecordingClient.Services.TenantService

Tenant service instance

Type:

timestamp :string|number

Type:
  • string | number

timezoneOffset :number

The timezone offset for the client, specified as the number of minutes that need to be added to the client's time to align it with UTC

Type:
  • number

token :string

Type:
  • string

user :string

Filter programs by user.

Type:
  • string

user :string

Filter programs by user.

Type:
  • string

user :string

Filter programs by user.

Type:
  • string

user :string

Authorized user id.

Type:
  • string

user :string

Filter programs by user.

Type:
  • string

user :string

Authorized user id.

Type:
  • string

userAgent :string

Filter results to only views whose user agent string contains this string

Type:
  • string

userAgent :string

Filter results to only views whose user agent string contains this string

Type:
  • string
Copyright 2017 Avaya Inc. All Rights Reserved.