Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RestClient

A wrapper for sending http requests to RingCentralService.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

agents

agents: string[] = [pkg.name + '/' + pkg.version]

appKey

appKey: string

appSecret

appSecret: string

handleRateLimit

handleRateLimit: boolean

server

server: string

tokenStore

tokenStore: TokenStore

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

auth

  • auth(opts: object): Promise<Token>

  • Parameters

    • opts: object
      • Optional accessTokenTtl?: number
      • Optional extension?: string
      • password: string
      • Optional refreshTokenTtl?: number
      • Optional scope?: string[]
      • username: string

    Returns Promise<Token>

call

  • call(endpoint: string, query?: __type, opts?: RequestInit): Promise<Response>

  • Parameters

    • endpoint: string
    • Optional query: __type
    • Optional opts: RequestInit

    Returns Promise<Response>

delete

  • delete(url: string, query?: __type): Promise<Response>

  • Parameters

    • url: string
    • Optional query: __type

    Returns Promise<Response>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

get

  • get(url: string, query?: __type): Promise<Response>

  • Send http GET method

    Parameters

    • url: string
    • Optional query: __type

    Returns Promise<Response>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getToken

  • getToken(ownerInfo?: RCAccount): Promise<Token>

  • Throw exception if no valid token.

    Parameters

    • Optional ownerInfo: RCAccount

    Returns Promise<Token>

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

logout

  • logout(): Promise<void>

oauth

  • oauth(code: string, redirectUri: string, opts?: object): Promise<Token>

  • Parameters

    • code: string
    • redirectUri: string
    • Optional opts: object
      • accessTokenTtl: string
      • refreshTokenTtl: string

    Returns Promise<Token>

oauthByUrl

  • oauthByUrl(callbackUrl: string, opts?: object): Promise<Token>

oauthUrl

  • oauthUrl(redirect_uri: string, opts?: object): string

  • Parameters

    • redirect_uri: string
    • Optional opts: object
      • Optional force?: boolean
      • Optional state?: string

    Returns string

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

parseOauthCallback

post

  • post(url: string, body: any, query?: __type): Promise<Response>

  • Body can be Blob, FormData, URLSearchParams, String, Buffer or stream.Readable, any other type, plain object or instance of class will stringified as json.

    Parameters

    • url: string
    • body: any
    • Optional query: __type

    Returns Promise<Response>

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

put

  • put(url: string, body: any, query?: __type): Promise<Response>

  • Type of body is the same as post.

    Parameters

    • url: string
    • body: any
    • Optional query: __type

    Returns Promise<Response>

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc