org.appformer.kogito.bridge.client.resource

Interface ResourceContentService

All Known Implementing Classes:

EnvelopeResourceContentService, NoOpResourceContentService

public interface ResourceContentService

Service to access resources in the project or workspace where the editor is open

Method Summary

Modifier and Type	Method and Description
elemental2.promise.Promise<String>	get(String uri) Returns a resource's content
elemental2.promise.Promise<String>	get(String uri, ResourceContentOptions options) Returns a resource's content
elemental2.promise.Promise<String[]>	list(String pattern) List files from the project/workspace where the editor is running
elemental2.promise.Promise<String[]>	list(String pattern, ResourceListOptions options) List files from the project/workspace where the editor is running

Method Detail

get

elemental2.promise.Promise<String> get(String uri)

Returns a resource's content

Parameters:

uri - the resource URI relative to the workspace/project

Returns:

The resource content or null if the resource is not available

get

elemental2.promise.Promise<String> get(String uri,
                                       ResourceContentOptions options)

Returns a resource's content

Parameters:

uri - The resource URI relative to the workspace/project

options - Options when retrieving the resource content

Returns:

The resource content or null if the resource is not available

list

elemental2.promise.Promise<String[]> list(String pattern)

List files from the project/workspace where the editor is running

Parameters:

pattern - A GLOB pattern to filter files. To list all files use "*"

Returns:

The list of matched resources URIs

list

elemental2.promise.Promise<String[]> list(String pattern,
                                          ResourceListOptions options)

List files from the project/workspace where the editor is running

Parameters:

pattern - A GLOB pattern to filter files. To list all files use "*"

options - Options when retrieving the resource list

Returns:

The list of matched resources URIs