Class VisualforceRemoting

Index

Constructors

Properties

connection connector initialized logger remotingInfo remotingUrl requestIdCounter visualForceTransport

Methods

getAvailableMethods getRedirectUrl getRemoteCallInfo getVisualForceUrl initialize invoke loadPageActions parseRemoteMethod

Constructors

constructor

new VisualforceRemoting(
connector: SalesforceConnectionProvider,
logger: Logger,
): VisualforceRemoting
Parameters
- connector: SalesforceConnectionProvider
- logger: Logger
Returns VisualforceRemoting
- Defined in packages/salesforce/src/visualforceRemoting.ts:69

Properties

`Private`connection

connection: SalesforceConnection

`Private` `Readonly`connector

connector: SalesforceConnectionProvider

`Private`initialized

initialized: boolean

`Private` `Readonly`logger

logger: Logger

`Private`remotingInfo

remotingInfo: VisualforceRemotingInfo

`Private`remotingUrl

remotingUrl: URL

`Private`requestIdCounter

requestIdCounter: number = 1

`Private`visualForceTransport

visualForceTransport: HttpTransport

Methods

getAvailableMethods

getAvailableMethods(): RemoteMethodSignature[]
Get the list of methods available

Returns RemoteMethodSignature[]
- Defined in packages/salesforce/src/visualforceRemoting.ts:78

`Private`getRedirectUrl

getRedirectUrl(response: string): undefined | null | string
Parameters
- response: string
Returns undefined | null | string
- Defined in packages/salesforce/src/visualforceRemoting.ts:146

`Private`getRemoteCallInfo

getRemoteCallInfo(
method: RemoteMethodSignature,
): VisualforceRemoteMethod & { action: string }
Parameters
- method: RemoteMethodSignature
Returns VisualforceRemoteMethod & { action: string }
- Defined in packages/salesforce/src/visualforceRemoting.ts:259

`Private`getVisualForceUrl

getVisualForceUrl(namespace: null | string, ...urlPath: string[]): string
Get the visual-force page URL
Parameters
- namespace: null | string
  Page namespace
- ...urlPath: string[]
  URL path parts
Returns string
- Defined in packages/salesforce/src/visualforceRemoting.ts:164

initialize

initialize(apexPage?: string, namespace?: string): Promise<VisualforceRemoting>
Initializes the APEX remote call manager for the specified page; makes available all calls from the specified APEX remote page
Parameters
- OptionalapexPage: string
  APEX remote page to initialize the remoting manager for
- namespace: string = 'c'
  Namespace of the APEX page
Returns Promise<VisualforceRemoting>
- Defined in packages/salesforce/src/visualforceRemoting.ts:93

invoke

invoke(
method: string | RemoteMethodSignature,
params?: unknown[],
): Promise<VisualforceRemotingResponse>
Executes the specified remote APEX method using an APEX remoting call.
Parameters
- method: string | RemoteMethodSignature
  Remote method signature or string describing the class and method (e.g. 'Class.method' or 'ns.Class.method')
- Optionalparams: unknown[]
  Optional list of params to pass to the call
Returns Promise<VisualforceRemotingResponse>
- Defined in packages/salesforce/src/visualforceRemoting.ts:184

`Private`loadPageActions

loadPageActions(remotingUrl: string, redirectCount?: number): any
Parameters
- remotingUrl: string
- redirectCount: number = 0
Returns any
- Defined in packages/salesforce/src/visualforceRemoting.ts:112

`Private`parseRemoteMethod

parseRemoteMethod(method: string | RemoteMethodSignature): RemoteMethodSignature
Parameters
- method: string | RemoteMethodSignature
Returns RemoteMethodSignature
- Defined in packages/salesforce/src/visualforceRemoting.ts:239