C# Class Microsoft.R.Support.Help.Packages.PackageIndex

Inheritance: IPackageIndex
ファイルを表示 Open project: Microsoft/RTVS Class Usage Examples

Private Properties

Property Type Description
BuildIndexAsync System.Threading.Tasks.Task
BuildInstalledPackagesIndexAsync System.Threading.Tasks.Task
BuildPreloadedPackagesFunctionListAsync System.Threading.Tasks.Task
BuildRemainingPackagesFunctionListAsync System.Threading.Tasks.Task
GetInstalledPackagesAsync Task>
GetPackageInfo IPackageInfo
OnBrokerStateChanged void
OnPackagesChanged void
OnSessionConnected void
PackageIndex System
RebuildIndexAsync System.Threading.Tasks.Task
ScheduleIdleTimeRebuild void
TryAddMissingPackagesAsync Task>

Public Methods

Method Description
BuildIndexAsync ( ) : System.Threading.Tasks.Task
ClearCache ( ) : void
Dispose ( ) : void
GetPackageInfoAsync ( string packageName ) : Task

Retrieves R package information by name. If package is not in the index, attempts to locate the package in the current R session.

GetPackagesInfoAsync ( IEnumerable packageNames ) : Task>

Retrieves information on multilple R packages. If one of the packages is not in the index, attempts to locate the package in the current R session.

WriteToDisk ( ) : void

Private Methods

Method Description
BuildIndexAsync ( IBinaryAsyncLockToken lockToken ) : System.Threading.Tasks.Task
BuildInstalledPackagesIndexAsync ( ) : System.Threading.Tasks.Task
BuildPreloadedPackagesFunctionListAsync ( ) : System.Threading.Tasks.Task
BuildRemainingPackagesFunctionListAsync ( ) : System.Threading.Tasks.Task
GetInstalledPackagesAsync ( ) : Task>
GetPackageInfo ( string packageName ) : IPackageInfo

Retrieves information on the package from index. Does not attempt to locate the package if it is not in the index such as when package was just installed.

OnBrokerStateChanged ( object sender, BrokerStateChangedEventArgs e ) : void
OnPackagesChanged ( object sender, EventArgs e ) : void
OnSessionConnected ( object sender, RConnectedEventArgs e ) : void
PackageIndex ( IRInteractiveWorkflowProvider interactiveWorkflowProvider, ICoreShell shell, IIntellisenseRSession host, IFunctionIndex functionIndex ) : System
RebuildIndexAsync ( ) : System.Threading.Tasks.Task
ScheduleIdleTimeRebuild ( ) : void
TryAddMissingPackagesAsync ( IEnumerable packageNames ) : Task>

From the supplied names selects packages that are not in the index and attempts to add them to the index. This typically applies to packages that were just installed.

Method Details

BuildIndexAsync() public method

public BuildIndexAsync ( ) : System.Threading.Tasks.Task
return System.Threading.Tasks.Task

ClearCache() public static method

public static ClearCache ( ) : void
return void

Dispose() public method

public Dispose ( ) : void
return void

GetPackageInfoAsync() public method

Retrieves R package information by name. If package is not in the index, attempts to locate the package in the current R session.
public GetPackageInfoAsync ( string packageName ) : Task
packageName string
return Task

GetPackagesInfoAsync() public method

Retrieves information on multilple R packages. If one of the packages is not in the index, attempts to locate the package in the current R session.
public GetPackagesInfoAsync ( IEnumerable packageNames ) : Task>
packageNames IEnumerable
return Task>

WriteToDisk() public method

public WriteToDisk ( ) : void
return void