C# 클래스 Microsoft.R.Support.Help.Functions.FunctionIndex

Contains index of function to package improving performance of locating package that contains the function documentation.
파일 보기 프로젝트 열기: Microsoft/RTVS 1 사용 예제들

공개 메소드들

메소드 설명
BuildIndexAsync ( IPackageIndex packageIndex = null ) : System.Threading.Tasks.Task
GetFunctionInfo ( string functionName, string packageName, string>.Action infoReadyCallback = null, object parameter = null ) : IFunctionInfo

Retrieves function information by name. If information is not available, starts asynchronous retrieval of the function info from R and when the data becomes available invokes specified callback passing the parameter. This is used for async intellisense or function signature/parameter help.

GetFunctionInfoAsync ( string functionName, string packageName = null ) : Task
RegisterPackageFunctions ( IPackageInfo package ) : void

비공개 메소드들

메소드 설명
FunctionIndex ( ICoreShell coreShell, IFunctionRdDataProvider rdDataProfider, IIntellisenseRSession host ) : System
GetFunctionInfoFromEngineAsync ( string functionName, string packageName, string>.Action infoReadyCallback = null, object parameter = null ) : Task

Fetches help on the function from R asynchronously. When function data is obtained, parsed and the function index is updated, method invokes infoReadyCallback callback passing the specified parameter. Callback method can now fetch function information from the index.

GetFunctionInfosFromRd ( string rdData ) : IReadOnlyList
GetQualifiedName ( string functionName, string packageName ) : string
RegisterFunction ( string functionName, string packageName ) : void
TryGetCachedFunctionInfo ( string functionName, string &packageName ) : IFunctionInfo

Attempts to retrieve function information from cache is a simple manner. Specifically, when function name is unique (then package name is irrelevant) or the package name is known.

UpdateIndex ( string functionName, string packageName, string rdData ) : void

메소드 상세

BuildIndexAsync() 공개 메소드

public BuildIndexAsync ( IPackageIndex packageIndex = null ) : System.Threading.Tasks.Task
packageIndex IPackageIndex
리턴 System.Threading.Tasks.Task

GetFunctionInfo() 공개 메소드

Retrieves function information by name. If information is not available, starts asynchronous retrieval of the function info from R and when the data becomes available invokes specified callback passing the parameter. This is used for async intellisense or function signature/parameter help.
public GetFunctionInfo ( string functionName, string packageName, string>.Action infoReadyCallback = null, object parameter = null ) : IFunctionInfo
functionName string
packageName string
infoReadyCallback string>.Action
parameter object
리턴 IFunctionInfo

GetFunctionInfoAsync() 공개 메소드

public GetFunctionInfoAsync ( string functionName, string packageName = null ) : Task
functionName string
packageName string
리턴 Task

RegisterPackageFunctions() 공개 메소드

public RegisterPackageFunctions ( IPackageInfo package ) : void
package IPackageInfo
리턴 void