Home Reference Source

Function

Static Public Summary
public
public
public
public
public
public
public

getBuyerCountry(): $Values<typeof>

public
public
public
public
public
public

getCommit(): $Values<typeof>

public

getComponents(): $ReadOnlyArray<$Values<typeof>>

public

getComputedLocales(locale: string): LocaleType

public
public

getCountry(): $Values<typeof>

public

getCurrency(): $Values<typeof>

public
public
public
public
public
public

getDisableCard(): $ReadOnlyArray<?$Values<typeof>>

public

getDisableFunding(): $ReadOnlyArray<?$Values<typeof>>

public

getEnableFunding(): $ReadOnlyArray<?$Values<typeof>>

public
public

getEnv(): $Values<typeof>

public

getFundingEligibility(): FundingEligibilityType

public
public
public

getIntent(): $Values<typeof>

public

getLang(): $Values<typeof>

public

getLocale(): LocaleType

public

getMerchantID(): $ReadOnlyArray<string>

public
public
public
public
public
public
public
public
public
public
public
public

getPlatform(): $Values<typeof>

public
public

getProtocol(): $Values<typeof>

public

getSDKAttribute(name: $Values<typeof>, def: T): T

public
public
public
public
public

getSDKQueryParam(name: *, def: *): *

public

getSDKQueryParamBool(name: $Values<typeof>, def: T): T

public
public
public
public

getSessionState(handler: function): T

public
public
public

getStorageState(handler: function): T

public
public
public
public
public

getVault(): $Values<typeof>

public
public
public
public

setup()

public

Static Public

public buildPayPalAPIUrl(path: string): string source

import {buildPayPalAPIUrl} from '@paypal/sdk-client/src/domains.js'

Params:

NameTypeAttributeDescription
path string
  • optional
  • default: undefined

Return:

string

public buildPayPalUrl(path: string): string source

import {buildPayPalUrl} from '@paypal/sdk-client/src/domains.js'

Params:

NameTypeAttributeDescription
path string
  • optional
  • default: undefined

Return:

string

public checkForCommonErrors() source

import {checkForCommonErrors} from '@paypal/sdk-client/src/errors.js'

public getAPIStageHost(): string source

import {getAPIStageHost} from '@paypal/sdk-client/src/global.js'

Return:

string (nullable: true)

public getAmount(): string source

import {getAmount} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getAuthAPIUrl(): string source

import {getAuthAPIUrl} from '@paypal/sdk-client/src/domains.js'

Return:

string

public getBuyerCountry(): $Values<typeof> source

import {getBuyerCountry} from '@paypal/sdk-client/src/script.js'

Return:

$Values<typeof> (nullable: true)

public getCSPNonce(): string source

import {getCSPNonce} from '@paypal/sdk-client/src/script.js'

Return:

string

public getClientAccessToken(): string source

import {getClientAccessToken} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getClientID(): string source

import {getClientID} from '@paypal/sdk-client/src/script.js'

Return:

string

public getClientMetadataID(): string source

import {getClientMetadataID} from '@paypal/sdk-client/src/session.js'

Return:

string (nullable: true)

public getClientToken(): string source

import {getClientToken} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getCommit(): $Values<typeof> source

import {getCommit} from '@paypal/sdk-client/src/script.js'

Return:

$Values<typeof>

public getComponents(): $ReadOnlyArray<$Values<typeof>> source

import {getComponents} from '@paypal/sdk-client/src/global.js'

Return:

$ReadOnlyArray<$Values<typeof>>

public getComputedLocales(locale: string): LocaleType source

import {getComputedLocales} from '@paypal/sdk-client/src/utils.js'

Params:

NameTypeAttributeDescription
locale string

Return:

LocaleType

public getCorrelationID(): string source

import {getCorrelationID} from '@paypal/sdk-client/src/global.js'

Return:

string

public getCountry(): $Values<typeof> source

import {getCountry} from '@paypal/sdk-client/src/script.js'

Return:

$Values<typeof>

public getCurrency(): $Values<typeof> source

import {getCurrency} from '@paypal/sdk-client/src/script.js'

Return:

$Values<typeof>

public getDebug(): boolean source

import {getDebug} from '@paypal/sdk-client/src/global.js'

Return:

boolean

public getDefaultAPIStageHost(): string source

import {getDefaultAPIStageHost} from '@paypal/sdk-client/src/global.js'

Return:

string (nullable: true)

public getDefaultNamespace(): string source

import {getDefaultNamespace} from '@paypal/sdk-client/src/global.js'

Return:

string

public getDefaultServiceStageHost(): string source

import {getDefaultServiceStageHost} from '@paypal/sdk-client/src/global.js'

Return:

string (nullable: true)

public getDefaultStageHost(): string source

import {getDefaultStageHost} from '@paypal/sdk-client/src/global.js'

Return:

string (nullable: true)

public getDisableCard(): $ReadOnlyArray<?$Values<typeof>> source

import {getDisableCard} from '@paypal/sdk-client/src/script.js'

Return:

$ReadOnlyArray<?$Values<typeof>>

public getDisableFunding(): $ReadOnlyArray<?$Values<typeof>> source

import {getDisableFunding} from '@paypal/sdk-client/src/script.js'

Return:

$ReadOnlyArray<?$Values<typeof>>

public getEnableFunding(): $ReadOnlyArray<?$Values<typeof>> source

import {getEnableFunding} from '@paypal/sdk-client/src/script.js'

Return:

$ReadOnlyArray<?$Values<typeof>>

public getEnableThreeDomainSecure(): boolean source

import {getEnableThreeDomainSecure} from '@paypal/sdk-client/src/script.js'

Return:

boolean

public getEnv(): $Values<typeof> source

import {getEnv} from '@paypal/sdk-client/src/global.js'

Return:

$Values<typeof>

public getFundingEligibility(): FundingEligibilityType source

import {getFundingEligibility} from '@paypal/sdk-client/src/global.js'

Return:

FundingEligibilityType

public getHost(): string source

import {getHost} from '@paypal/sdk-client/src/global.js'

Return:

string

public getHostName(): string source

import {getHostName} from '@paypal/sdk-client/src/global.js'

Return:

string

public getIntent(): $Values<typeof> source

import {getIntent} from '@paypal/sdk-client/src/script.js'

Return:

$Values<typeof>

public getLang(): $Values<typeof> source

import {getLang} from '@paypal/sdk-client/src/script.js'

Return:

$Values<typeof>

public getLocale(): LocaleType source

import {getLocale} from '@paypal/sdk-client/src/script.js'

Return:

LocaleType

public getMerchantID(): $ReadOnlyArray<string> source

import {getMerchantID} from '@paypal/sdk-client/src/script.js'

Return:

$ReadOnlyArray<string>

public getMerchantRequestedPopupsDisabled(): boolean source

import {getMerchantRequestedPopupsDisabled} from '@paypal/sdk-client/src/script.js'

Return:

boolean

public getNamespace(): string source

import {getNamespace} from '@paypal/sdk-client/src/script.js'

Return:

string

public getOrderAPIUrl(): string source

import {getOrderAPIUrl} from '@paypal/sdk-client/src/domains.js'

Return:

string

public getPageType(): string source

import {getPageType} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getPartnerAttributionID(): string source

import {getPartnerAttributionID} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getPath(): string source

import {getPath} from '@paypal/sdk-client/src/global.js'

Return:

string

public getPayPalAPIDomain(): string source

import {getPayPalAPIDomain} from '@paypal/sdk-client/src/global.js'

Return:

string

public getPayPalDomain(): string source

import {getPayPalDomain} from '@paypal/sdk-client/src/global.js'

Return:

string

public getPayPalDomainRegex(): RegExp source

import {getPayPalDomainRegex} from '@paypal/sdk-client/src/domains.js'

Return:

RegExp

public getPayPalLoggerDomain(): string source

import {getPayPalLoggerDomain} from '@paypal/sdk-client/src/domains.js'

Return:

string

public getPayPalLoggerUrl(): string source

import {getPayPalLoggerUrl} from '@paypal/sdk-client/src/domains.js'

Return:

string

public getPlatform(): $Values<typeof> source

import {getPlatform} from '@paypal/sdk-client/src/global.js'

Return:

$Values<typeof>

public getPort(): number source

import {getPort} from '@paypal/sdk-client/src/global.js'

Return:

number

public getProtocol(): $Values<typeof> source

import {getProtocol} from '@paypal/sdk-client/src/global.js'

Return:

$Values<typeof>

public getSDKAttribute(name: $Values<typeof>, def: T): T source

import {getSDKAttribute} from '@paypal/sdk-client/src/script.js'

Params:

NameTypeAttributeDescription
name $Values<typeof>
def T

Return:

T

public getSDKHost(): string source

import {getSDKHost} from '@paypal/sdk-client/src/global.js'

Return:

string

public getSDKInitTime(): number source

import {getSDKInitTime} from '@paypal/sdk-client/src/tracking.js'

Return:

number

public getSDKIntegrationSource(): string source

import {getSDKIntegrationSource} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getSDKMeta(): string source

import {getSDKMeta} from '@paypal/sdk-client/src/meta.js'

Return:

string

public getSDKQueryParam(name: *, def: *): * source

import {getSDKQueryParam} from '@paypal/sdk-client/src/script.js'

Params:

NameTypeAttributeDescription
name *
def *

Return:

*

public getSDKQueryParamBool(name: $Values<typeof>, def: T): T source

import {getSDKQueryParamBool} from '@paypal/sdk-client/src/script.js'

Params:

NameTypeAttributeDescription
name $Values<typeof>
def T

Return:

T

public getSDKQueryParams(): object source

import {getSDKQueryParams} from '@paypal/sdk-client/src/script.js'

Return:

object

public getScriptUrl(): string source

import {getScriptUrl} from '@paypal/sdk-client/src/script.js'

Return:

string

public getSessionID(): string source

import {getSessionID} from '@paypal/sdk-client/src/session.js'

Return:

string

public getSessionState(handler: function): T source

import {getSessionState} from '@paypal/sdk-client/src/session.js'

Params:

NameTypeAttributeDescription
handler function

Return:

T

public getStageHost(): string source

import {getStageHost} from '@paypal/sdk-client/src/global.js'

Return:

string (nullable: true)

public getStorageID(): string source

import {getStorageID} from '@paypal/sdk-client/src/session.js'

Return:

string

public getStorageState(handler: function): T source

import {getStorageState} from '@paypal/sdk-client/src/session.js'

Params:

NameTypeAttributeDescription
handler function

Return:

T

public getUserAccessToken(): string source

import {getUserAccessToken} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getUserAuthCode(): string source

import {getUserAuthCode} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getUserExperienceFlow(): string source

import {getUserExperienceFlow} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getUserIDToken(): string source

import {getUserIDToken} from '@paypal/sdk-client/src/script.js'

Return:

string (nullable: true)

public getVault(): $Values<typeof> source

import {getVault} from '@paypal/sdk-client/src/script.js'

Return:

$Values<typeof>

public getVersion(): string source

import {getVersion} from '@paypal/sdk-client/src/global.js'

Return:

string

public isChildWindow(): boolean source

import {isChildWindow} from '@paypal/sdk-client/src/script.js'

Return:

boolean

public isPayPalDomain(): boolean source

import {isPayPalDomain} from '@paypal/sdk-client/src/domains.js'

Return:

boolean

public setup() source

public setupLogger() source

import {setupLogger} from '@paypal/sdk-client/src/tracking.js'