Class CrmEnv

Defines the connection properties for your Efficy web API

Constructors

constructor

Properties

apiKey? cookies? customer? env? id? interceptors logOff? name pwd? retryWithNewSession? url? useCookies? useFetchQueue? user?

Accessors

cookieHeader sessionId shortSessionId

Methods

clearCookies setEnv

Constructors

constructor

Properties

Optional apiKey

apiKey?: string

Optional cookies

cookies?: Cookie[]

Optional customer

customer?: string

Private Optional env

env?: CrmEnvConfig

The definition object of the targeted CRM environment.

Optional id

id?: string

Readonly interceptors

interceptors: Readonly<{
    onError: CrmFetchErrorInterceptor;
    onPositiveResponse: CrmFetchResponseInterceptor;
    onRequest: CrmFetchRequestInterceptor;
}> = ...

Type declaration

Optional logOff

logOff?: boolean

Private name

name: string = "CrmEnv"

Optional pwd

pwd?: string

Optional retryWithNewSession

retryWithNewSession?: boolean

Optional url

url?: string

Optional useCookies

useCookies?: boolean

Optional useFetchQueue

useFetchQueue?: boolean

Optional user

user?: string

Accessors

cookieHeader

  • get cookieHeader(): string

  • Returns the request header for cookies.

    Returns string

sessionId

  • get sessionId(): string

  • Returns the session ID from cookies.

    Returns string

shortSessionId

  • get shortSessionId(): string

  • Returns the first part of the session ID.

    Returns string

Methods

clearCookies

setEnv

  • setEnv(env): void

  • Updates the CRM environment configuration.

    Parameters

    • env: CrmEnvConfig

      The definition object of the targeted CRM environment.

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorapiKeycookiescustomerenvidinterceptorslogOffnamepwdretryWithNewSessionurluseCookiesuseFetchQueueusercookieHeadersessionIdshortSessionIdclearCookiessetEnv