RpcOperation Class

An RPC operation descriptor.

Methods

Name Description
allowResponseCaching(control: RpcResponseCacheControl = RpcResponseCacheControl.Immutable): (Anonymous function) Static Convenience decorator for setting an RPC operation policy that allows response caching.  
forEach(definition: RpcInterfaceDefinition, callback: (operation: RpcOperation) => void): void Static Iterates the operations of an RPC interface definition.  
lookup(target: string | RpcInterfaceDefinition, operationName: string): RpcOperation Static Looks up an RPC operation by name.  
obtainInstance(obj: RpcOperationPolicy | RpcOperationPolicyProps): RpcOperationPolicy Static    
setDefaultPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps): (Anonymous function) Static Decorator for setting the default policy for an RPC interface definition class.  
setPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps): (Anonymous function) Static Decorator for setting the policy for an RPC operation function.  

Properties

Name Type Description
fallbackToken Static IModelToken | undefined A fallback token to use for RPC requests that do not semantically depend on an iModel.  
interfaceDefinition RpcInterfaceDefinition The RPC interface definition for this operation.  
interfaceVersion Accessor ReadOnly string The version of this operation.  
operationName string The name of this operation.  
policy RpcOperationPolicy The policy for this operation.  

Defined in

Last Updated: 10 September, 2019