diff --git a/classes/react_src.AuthGate.html b/classes/react_src.AuthGate.html index 2e3797e..d9863eb 100644 --- a/classes/react_src.AuthGate.html +++ b/classes/react_src.AuthGate.html @@ -1,4 +1,4 @@ -AuthGate | @ringcentral/mono

Hierarchy

Constructors

constructor +AuthGate | @ringcentral/mono

Hierarchy

Constructors

Properties

context mounted props @@ -37,13 +37,13 @@
mounted: boolean = false

purposely going through antipattern because we can't cancel promises for now we still cancel subscriptions etc., but we can't guarantee when storage promises will resolve

-
props: Readonly<AuthGateProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: {
    authError: any;
    authorizing: boolean;
    isAuthorized: boolean;
} = ...

Type declaration

  • authError: any
  • authorizing: boolean
  • isAuthorized: boolean
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

+
props: Readonly<AuthGateProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: {
    authError: any;
    authorizing: boolean;
    isAuthorized: boolean;
} = ...

Type declaration

  • authError: any
  • authorizing: boolean
  • isAuthorized: boolean
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}
defaultProps: {
    ensure: boolean;
} = ...

Type declaration

  • ensure: boolean

Methods

  • Called immediately before mounting occurs, and before Component#render. +

defaultProps: {
    ensure: boolean;
} = ...

Type declaration

  • ensure: boolean

Methods

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause +

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    -

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns Promise<void>

  • Called immediately after updating occurs. Not called for the initial render.

    +

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns Promise<void>

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Called immediately before rendering when new props or state is received. Not called for the initial render.

    +
  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and +

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    -

    Parameters

    Returns any

  • Type Parameters

    Parameters

    Returns void

  • Called to determine whether the change in props and state should trigger a re-render.

    +

    Parameters

    Returns any

  • Type Parameters

    Parameters

    Returns void

  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    -

    Parameters

    Returns boolean

\ No newline at end of file +

Parameters

Returns boolean

\ No newline at end of file diff --git a/classes/redux_src.default.html b/classes/redux_src.default.html index e454712..de83587 100644 --- a/classes/redux_src.default.html +++ b/classes/redux_src.default.html @@ -1,4 +1,4 @@ -default | @ringcentral/mono

Constructors

constructor +default | @ringcentral/mono

Constructors

Properties

Constructors

Properties

actions: default
reducer: Reducer<CombinedState<{
    error: any;
    loading: boolean;
    status: boolean;
}>, AnyAction> = ...
root: string
sdk: SDK
store: Store<any, AnyAction>

Methods

  • Parameters

    • store: Store<any, AnyAction>

    Returns Promise<void>

\ No newline at end of file +

Constructors

Properties

actions: default
reducer: Reducer<CombinedState<{
    error: any;
    loading: boolean;
    status: boolean;
}>, AnyAction> = ...
root: string
sdk: SDK
store: Store<any, AnyAction>

Methods

  • Parameters

    • store: Store<any, AnyAction>

    Returns Promise<void>

\ No newline at end of file diff --git a/classes/sdk_src.Cache.html b/classes/sdk_src.Cache.html index e3a2900..d56be0b 100644 --- a/classes/sdk_src.Cache.html +++ b/classes/sdk_src.Cache.html @@ -1,4 +1,4 @@ -Cache | @ringcentral/mono

Constructors

constructor +Cache | @ringcentral/mono

Constructors

Properties

_externals: any = null
_prefix: any = null
defaultPrefix: string = 'rc-'

Methods

\ No newline at end of file +

Constructors

Properties

_externals: any = null
_prefix: any = null
defaultPrefix: string = 'rc-'

Methods

\ No newline at end of file diff --git a/classes/sdk_src.Externals.html b/classes/sdk_src.Externals.html index 721d18e..2089750 100644 --- a/classes/sdk_src.Externals.html +++ b/classes/sdk_src.Externals.html @@ -1,7 +1,7 @@ -Externals | @ringcentral/mono

Implements

Constructors

constructor +Externals | @ringcentral/mono

Implements

Constructors

Properties

Headers: any = root.Headers
Request: any = root.Request
Response: any = root.Response
fetch: any = root.fetch
localStorage: any = root.localStorage
\ No newline at end of file +

Constructors

Properties

Headers: any = root.Headers
Request: any = root.Request
Response: any = root.Response
fetch: any = root.fetch
localStorage: any = root.localStorage
\ No newline at end of file diff --git a/classes/sdk_src.SDK.html b/classes/sdk_src.SDK.html index 4c490b8..3f83c9d 100644 --- a/classes/sdk_src.SDK.html +++ b/classes/sdk_src.SDK.html @@ -1,4 +1,4 @@ -SDK | @ringcentral/mono

Constructors

constructor +SDK | @ringcentral/mono

Constructors

Properties

Constructors

Properties

_cache: Cache
_client: default
_externals: Externals
_platform: default
EventEmitter: typeof EventEmitter = EventEmitter
server: {
    production: string;
    sandbox: string;
} = ...

Type declaration

  • production: string
  • sandbox: string
version: any = Constants.version

Methods

  • Parameters

    • url: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • response: Response

    Returns Promise<string>

  • Parameters

    • url: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • response: Response

    Returns string

  • Parameters

    • response: Response

    Returns any

  • Parameters

    • response: Response

    Returns Promise<Response[]>

  • Parameters

    • url: any
    • Optional body: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • url: any
    • Optional body: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • url: any
    • Optional body: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • path: any

    Returns Promise<string>

  • Parameters

    • origin: any
    • win: any

    Returns void

\ No newline at end of file +

Constructors

Properties

_cache: Cache
_client: default
_externals: Externals
_platform: default
EventEmitter: typeof EventEmitter = EventEmitter
server: {
    production: string;
    sandbox: string;
} = ...

Type declaration

  • production: string
  • sandbox: string
version: any = Constants.version

Methods

  • Parameters

    • url: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • response: Response

    Returns Promise<string>

  • Parameters

    • url: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • response: Response

    Returns string

  • Parameters

    • response: Response

    Returns any

  • Parameters

    • response: Response

    Returns Promise<Response[]>

  • Parameters

    • url: any
    • Optional body: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • url: any
    • Optional body: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • url: any
    • Optional body: any
    • Optional query: any
    • Optional options: SendOptions

    Returns Promise<Response>

  • Parameters

    • path: any

    Returns Promise<string>

  • Parameters

    • origin: any
    • win: any

    Returns void

\ No newline at end of file diff --git a/classes/subscriptions_src.Subscription.html b/classes/subscriptions_src.Subscription.html index c222a9d..94bc5b0 100644 --- a/classes/subscriptions_src.Subscription.html +++ b/classes/subscriptions_src.Subscription.html @@ -1,4 +1,4 @@ -Subscription | @ringcentral/mono

Hierarchy

  • EventEmitter
    • Subscription

Constructors

constructor +Subscription | @ringcentral/mono

Hierarchy

  • EventEmitter
    • Subscription

Constructors

Properties

Constructors

Properties

eventFilters: string[]
events: {
    notification: string;
} = ...

Type declaration

  • notification: string
subscriptions: Subscriptions
captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

+

Constructors

Properties

eventFilters: string[]
events: {
    notification: string;
} = ...

Type declaration

  • notification: string
subscriptions: Subscriptions
captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

defaultMaxListeners: number
errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

@@ -114,7 +114,7 @@
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Parameters

  • eventName: string | symbol

Returns Function[]

Since

v9.4.0

-
  • Removes all listeners, or those of the specified eventName.

    +
  • Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    @@ -144,7 +144,7 @@

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

    -
  • By default EventEmitters will print a warning if more than 10 listeners are +