@pod-os/core / PodOS
Class: PodOS
Defined in: index.ts:48
Constructors
Constructor
new PodOS(
__namedParameters?):PodOS
Defined in: index.ts:60
Parameters
__namedParameters?
PodOsConfiguration = {}
Returns
PodOS
Properties
store
readonlystore:Store
Defined in: index.ts:50
uriService
readonlyuriService:UriService
Defined in: index.ts:51
Methods
addNewThing()
addNewThing(
uri,name,type):Promise\<void>
Defined in: index.ts:155
Parameters
uri
string
name
string
type
string
Returns
Promise\<void>
addPropertyValue()
addPropertyValue(
thing,property,value):Promise\<void>
Defined in: index.ts:133
Adds a new value to the property of the given thing
Parameters
thing
property
string
value
string
Returns
Promise\<void>
addRelation()
addRelation(
thing,property,value):Promise\<void>
Defined in: index.ts:147
Adds a new relation (link) from the thing to the given uri using the property
Parameters
thing
property
string
value
string
Returns
Promise\<void>
addToLabelIndex()
addToLabelIndex(
thing,labelIndex):Promise\<void>
Defined in: index.ts:208
Adds a label of the given thing to the label index, so that it can be found after the search index has been rebuilt
Parameters
thing
The thing to index
labelIndex
The index to update
Returns
Promise\<void>
attachments()
attachments():
AttachmentGateway
Defined in: index.ts:242
Provides access to attachment operations such as uploading and linking attachments to things
Returns
An instance of AttachmentGateway that handles attachment operations
Since
0.24.0
buildSearchIndex()
buildSearchIndex(
profile):Promise\<SearchIndex>
Defined in: index.ts:182
Fetch the private label index for the given profile and build a search index from it
Parameters
profile
Returns
Promise\<SearchIndex>
createDefaultLabelIndex()
createDefaultLabelIndex(
profile):Promise\<LabelIndex>
Defined in: index.ts:218
Creates a new label index document at a default location and links it to the user's profile or preferences document
Parameters
profile
The profile for that to create the index
Returns
Promise\<LabelIndex>
the newly created label index
fetch()
fetch(
uri):Promise\<Response>
Defined in: index.ts:102
Parameters
uri
string
Returns
Promise\<Response>
fetchAll()
fetchAll(
uris):Promise\<PromiseSettledResult\<Response>[]>
Defined in: index.ts:106
Parameters
uris
string[]
Returns
Promise\<PromiseSettledResult\<Response>[]>
~~fetchFile()~~
fetchFile(
url):Promise\<SolidFile>
Defined in: index.ts:115
Parameters
url
string
URL identifying the file
Returns
Promise\<SolidFile>
An object representing the fetched file
Deprecated
Use FileFetcher.fetchFile via PodOS.files instead
fetchProfile()
fetchProfile(
webId):Promise\<WebIdProfile>
Defined in: index.ts:174
Fetch the WebId profile and preferences file for the given WebID
Parameters
webId
string
Returns
Promise\<WebIdProfile>
files()
files():
FileFetcher
Defined in: index.ts:123
Provides access to file operations such as fetching and updating files in the pod
Returns
An instance of FileFetcher that handles file operations
listKnownTerms()
listKnownTerms():
Term[]
Defined in: index.ts:151
Returns
Term[]
loadModule()
loadModule\<
T>(moduleName):Promise\<T>
Defined in: index.ts:199
Dynamically loads a module by its name and returns an instance of the module
Type Parameters
T
T
Parameters
moduleName
string
Returns
Promise\<T>
login()
login(
oidcIssuer?):Promise\<void>
Defined in: index.ts:191
Parameters
oidcIssuer?
string = "http://localhost:3000"
Returns
Promise\<void>
logout()
logout():
Promise\<void>
Defined in: index.ts:186
Returns
Promise\<void>
observeSession()
observeSession():
BehaviorSubject\<SessionInfo>
Defined in: index.ts:166
returns a behavior subject that can be used to observe changes in the session state
Returns
BehaviorSubject\<SessionInfo>
proposeAppsFor()
proposeAppsFor(
thing):OpenWithApp[]
Defined in: index.ts:251
Propose matching apps to open a thing
Parameters
thing
The thing to open
Returns
An array of apps that can open the thing. The array is empty if no apps are found.
proposeUriForNewThing()
proposeUriForNewThing(
referenceUri,name):string
Defined in: index.ts:159
Parameters
referenceUri
string
name
string
Returns
string
uploadAndAddPicture()
uploadAndAddPicture(
thing,pictureFile):ResultAsync\<{url:string; },NetworkProblem|HttpProblem>
Defined in: index.ts:230
Uploads a picture file and associates it with a thing. The container is automatically derived from the thing's URI.
Parameters
thing
The thing to add the picture to
pictureFile
File
The picture file to upload
Returns
ResultAsync\<{ url: string; }, NetworkProblem | HttpProblem>
Result with the picture URL or error