Class RevClient

All API interactions are wrapped up in the RevClient class.

Example

import {RevClient} from '/path/to/rev-client.js';

// create client object
const rev = new RevClient({
   url: 'https://my.rev.url',
   apiKey: 'my.user.apikey',
   secret: 'my.user.secret',
   // or can login via username + password
   // username: 'my.username',
   // password: 'my.password',
   logEnabled: true, // turn on debug logging
   keepAlive: true // automatically extend session
   rateLimits: true // automatically enforce rate limiting (avoid 429 error responses)
});

(async () => {
   // call login api and start session. will throw error if invalid login
   await rev.connect();

   // get details of current user
   const currentUser = await rev.user.details('me');
   console.log(currentUser);
});

Index

Constructors

constructor

Properties

instance properties

url isConnected sessionExpires sessionState token

APIs

Methods to call the Rev APIs are broken up into namespaces. They roughly match up to the categories in the Rev API Docs Documentation for the individual api namespaces are broken out into separate pages:

.admin: admin api
.admin: Admin Methods
.audit: Audit Methods
.auth: Auth Methods
.category: Category Methods
.channel: Channel Methods
.device: Device Methods
.environment: Environment Methods
.group: Group Methods
.playlist: Playlist Methods
.recording: Recording Methods
.upload: Upload Methods
.user: User Methods
.video: Video Methods
.webcast: Webcast Methods
.zones: Zone Methods

admin audit auth category channel device environment group playlist recording upload user video webcast zones

Internal

for internal use

logEnabled session log

Request

Methods to directly make (authenticated) HTTP requests

delete get patch post put request

Session

Methods to maintain the authentication session (accessToken)

connect disconnect extendSession verifySession

Constructors

constructor

new RevClient(options: Rev.Options): RevClient
Parameters
- options: Rev.Options
  The configuration options including target Rev URL and authentication credentials
Returns RevClient
- Defined in src/rev-client.ts:170

Properties

url

url: string

The Rev tenant url (i.e. https://my.rev.url)

isConnected

get isConnected(): boolean
Returns true if session is connected and token's expiration date is in the future

Returns boolean
- Defined in src/rev-client.ts:512

sessionExpires

get sessionExpires(): Date
Date value when current accessToken will expire

Returns Date
- Defined in src/rev-client.ts:528

sessionState

get sessionState(): IRevSessionState
get/set serialized session state (accessToken, expiration, and userId/apiKey) Useful if you need to create a new RevClient instance with the same accessToken

Returns IRevSessionState
- Defined in src/rev-client.ts:537
set sessionState(state: IRevSessionState): void
get/set serialized session state (accessToken, expiration, and userId/apiKey) Useful if you need to create a new RevClient instance with the same accessToken
Parameters
- state: IRevSessionState
Returns void
- Defined in src/rev-client.ts:546

token

get token(): undefined | string
the current session's accessToken

Returns undefined | string
- Defined in src/rev-client.ts:520

APIs

Internal

logEnabled

logEnabled: boolean

turns on/off debug logging to console

session

session: IRevSession

This is an internal class that handles authentication and maintaining the session. It should not be used directly.

log

log(severity: LogSeverity, ...args: any[]): void
used internally to write debug log entries. Does nothing if logEnabled is false
Parameters
- severity: LogSeverity
- ...args: any[]
Returns void
- Defined in src/rev-client.ts:563

Request

delete

delete(endpoint: string, data?: {}, options?: RequestOptions): Promise<void>
Make a DELETE Request
Parameters
- endpoint: string
  API path
- Optionaldata: {}
  query parameters as JSON object
- Optionaloptions: RequestOptions
  Additional request options
Returns Promise<void>
- Defined in src/rev-client.ts:460

get

get<T = any>(endpoint: string, data?: {}, options?: RequestOptions): Promise<T>
Make a GET Request
Type Parameters
- T = any
Parameters
- endpoint: string
  API path
- Optionaldata: {}
  Query parameters as json object
- Optionaloptions: RequestOptions
  Additional request options
Returns Promise<T>
Depends on options.responseType/API response - usually JSON object except for binary download endpoints
- Defined in src/rev-client.ts:409

patch

patch(endpoint: string, data?: {}, options?: RequestOptions): Promise<void>
Make a PATCH Request
Parameters
- endpoint: string
  API path
- Optionaldata: {}
  Request body
- Optionaloptions: RequestOptions
  Additional request options
Returns Promise<void>
- Defined in src/rev-client.ts:448

post

post<T = any>(endpoint: string, data?: {}, options?: RequestOptions): Promise<T>
Make a POST Request
Type Parameters
- T = any
Parameters
- endpoint: string
  API path
- Optionaldata: {}
  Request body
- Optionaloptions: RequestOptions
  Additional request options
Returns Promise<T>
Depends on options.responseType/API response - usually JSON object
- Defined in src/rev-client.ts:422

put

put<T = any>(endpoint: string, data?: {}, options?: RequestOptions): Promise<T>
Make a GET Request
Type Parameters
- T = any
Parameters
- endpoint: string
  API path
- Optionaldata: {}
  Request body
- Optionaloptions: RequestOptions
  Additional request options
Returns Promise<T>
Depends on options.responseType/API response - usually JSON object or void
- Defined in src/rev-client.ts:435

request

request<T = any>(
    method: HTTPMethod,
    endpoint: string,
    data?: any,
    options?: RequestOptions,
): Promise<Rev.Response<T>>
make a REST request. The Authorization http header for the current session will automatically be added.
Type Parameters
- T = any
Parameters
- method: HTTPMethod
  HTTP Method
- endpoint: string
  API endpoint path
- data: any = undefined
  Request body if PUT/POST/PATCH or query parameters object if GET/DELETE/HEAD. objects/arrays are automatically stringified
- options: RequestOptions = {}
  additional request options, including additional HTTP Headers if necessary.
Returns Promise<Rev.Response<T>>
the decoded response body as well as statuscode/headers/and raw response
- Defined in src/rev-client.ts:241

Session

connect

connect(): Promise<void>
authenticate with Rev

Returns Promise<void>
- Defined in src/rev-client.ts:468

disconnect

disconnect(): Promise<void>
end rev session

Returns Promise<void>
- Defined in src/rev-client.ts:482

extendSession

extendSession(): Promise<void>
Call the Extend Session API to maintain the current session's expiration time Note that this API call is automatically handled unless keepAlive: false was specified in configuring the client.

Returns Promise<void>
- Defined in src/rev-client.ts:495

verifySession

verifySession(): Promise<boolean>
Returns true/false based on if the session is currently valid

Returns Promise<boolean>
Promise
- Defined in src/rev-client.ts:504

Class RevClient

Example

Index

Constructors

Properties

APIs

Internal

Request

Session

Constructors

constructor

Parameters

Returns RevClient

Properties

url

isConnected

Returns boolean

sessionExpires

Returns Date

sessionState

Returns IRevSessionState

Parameters

Returns void

token

Returns undefined | string

APIs

Readonlyadmin

Readonlyaudit

Readonlyauth

Readonlycategory

Readonlychannel

Readonlydevice

Readonlyenvironment

Readonlygroup

Readonlyplaylist

Readonlyrecording

Readonlyupload

Readonlyuser

Readonlyvideo

Readonlywebcast

Readonlyzones

Internal

logEnabled

session

log

Parameters

Returns void

Request

delete

Parameters

Returns Promise<void>

get

Type Parameters

Parameters

Returns Promise<T>

patch

Parameters

Returns Promise<void>

post

Type Parameters

Parameters

Returns Promise<T>

put

Type Parameters

Parameters

Returns Promise<T>

request

Type Parameters

Parameters

Returns Promise<Rev.Response<T>>

Session

connect

Returns Promise<void>

disconnect

Returns Promise<void>

extendSession

Returns Promise<void>

verifySession

Returns Promise<boolean>

Settings

`Readonly`admin

`Readonly`audit

`Readonly`auth

`Readonly`category

`Readonly`channel

`Readonly`device

`Readonly`environment

`Readonly`group

`Readonly`playlist

`Readonly`recording

`Readonly`upload

`Readonly`user

`Readonly`video

`Readonly`webcast

`Readonly`zones