Interface Options

The main configuration options for setting up the Rev API Client

interface Options {
    apiKey?: string;
    authCode?: string;
    code?: string;
    codeVerifier?: string;
    defaultStreamPreference?: "stream" | "webstream" | "nativestream";
    guestRegistrationToken?: string;
    jwtToken?: string;
    keepAlive?: boolean | KeepAliveOptions;
    log?: LogFunction;
    logEnabled?: boolean;
    oauthConfig?: Config;
    password?: string;
    publicOnly?: boolean;
    rateLimits?: boolean | RateLimits;
    secret?: string;
    session?: IRevSessionState;
    url: string;
    username?: string;
    webcastId?: string;
}

Hierarchy (View Summary)

API Key Login

apiKey? secret?

Advanced

defaultStreamPreference? keepAlive? log? logEnabled? rateLimits?

Custom Login

publicOnly? session?

Guest Login

guestRegistrationToken? webcastId?

JWT Login

jwtToken?

OAuth Login

authCode? code? codeVerifier? oauthConfig?

Required

url is required

url

Username Login

password? username?

API Key Login

OptionalapiKey

apiKey?: string

API Key forRev User (for login) - this or username must be specified

Optionalsecret

secret?: string

API Secret for Rev User (for login) - this or password must be specified

Advanced

OptionaldefaultStreamPreference

defaultStreamPreference?: "stream" | "webstream" | "nativestream"

Specify the default response type for streaming responses 'stream': whatever underlying library returns (NodeJS Readable for node-fetch, ReadableStream otherwise) 'webstream': always return a ReadableStream 'nativestream': always return native stream type (NodeJS Readable on NodeJS, ReadableStream otherwise)

OptionalkeepAlive

keepAlive?: boolean | KeepAliveOptions

If true then automatically extend the Rev session at regular intervals, until rev.disconnect() is called. Optionally, pass in keepAlive options instead of true

Optionallog

log?: LogFunction

Logging function - default is log to console

OptionallogEnabled

logEnabled?: boolean

Enable/disable logging

OptionalrateLimits

rateLimits?: boolean | RateLimits

Turn on/off rate limits Automatically throttle requests client-side to fit within Vbrick's API Request Rate Limits. Note that the default values (when value is true) is set to the account maximum

Custom Login

OptionalpublicOnly

publicOnly?: boolean

use public APIs only - no authentication

Optionalsession

session?: IRevSessionState

existing token/extend session details

Guest Login

OptionalguestRegistrationToken

guestRegistrationToken?: string

Webcast Guest Registration

OptionalwebcastId

webcastId?: string

Webcast ID for Guest Registration

JWT Login

OptionaljwtToken

jwtToken?: string

JWT Token

OAuth Login

OptionalauthCode

authCode?: string

authCode from deprecated legacy oauth authorization flow

Deprecated

Optionalcode

code?: string

code from oauth2 authorization flow

OptionalcodeVerifier

codeVerifier?: string

code verifier from oauth2 authorization flow

OptionaloauthConfig

oauthConfig?: Config

oauth configuration values for oauth token management

Required

url

url: string

URL of Rev account

Username Login

Optionalpassword

password?: string

Password of Rev User (for login) - this or secret must be specified

Optionalusername

username?: string

Username of Rev User (for login) - this or apiKey must be specified

Settings

Member Visibility

On This Page

API Key Login
Advanced
Custom Login
Guest Login
JWT Login
OAuth Login
Required
Username Login