Class SolidProfileObject

Hierarchy

DataObject
- SolidProfileObject

Index

Constructors

constructor

new SolidProfileObject(webId?): SolidProfileObject
Parameters
- Optional webId: string
Returns SolidProfileObject
Overrides DataObject.constructor
- Defined in src/common/SolidProfileObject.ts:22

Properties

createdTimestamp

createdTimestamp: number

Created timestamp

displayName

displayName: string

Object display name

oidcIssuer

oidcIssuer: string

OpenID Issuer

parentUID

parentUID: string

sessionId

sessionId: string

Session Identifier

uid

uid: string

Object identifier

Returns

Unique object identifier

Accessors

position

get position(): AbsolutePosition
Get the current absolute position of the object relative to the global reference space

Returns AbsolutePosition
Absolute position of data object
Inherited from DataObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:60
set position(position): void
Set the current absolute position of the object relative to the global reference space
Parameters
- position: AbsolutePosition
Returns void
Inherited from DataObject.position
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:65

profileDocumentUrl

get profileDocumentUrl(): URL
Get the profile document URL without trailing hashtag

Returns URL
Profile URL
- Defined in src/common/SolidProfileObject.ts:41

relativePositions

get relativePositions(): RelativePosition<any, Unit>[]
Get relative positions

Returns RelativePosition<any, Unit>[]
Array of relative positions
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:93
set relativePositions(relativePostions): void
Parameters
- relativePostions: RelativePosition<any, Unit>[]
Returns void
Inherited from DataObject.relativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:94

webId

get webId(): string
Unique WebID

Returns string
Overrides DataObject.webId
- Defined in src/common/SolidProfileObject.ts:29
set webId(value): void
Parameters
- value: string
Returns void
Overrides DataObject.webId
- Defined in src/common/SolidProfileObject.ts:33

Methods

addRelativePosition

addRelativePosition(relativePosition): SolidProfileObject
Add a relative position to this data object
Parameters
- relativePosition: RelativePosition<any, Unit>
  
  Relative position to add
Returns SolidProfileObject
Data object instance
Inherited from DataObject.addRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:109

bind

bind(service): DataObjectBinding<SolidProfileObject>
Bind the data object to a service
Parameters
- service: DataService<string, SolidProfileObject>
  
  Service to bind it to
Returns DataObjectBinding<SolidProfileObject>
Data object binding with a service
Inherited from DataObject.bind
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:132

clone

clone<T>(dataType?): T
Clone the data object
Type Parameters
- T extends SolidProfileObject<T>
Parameters
- Optional dataType: Constructor<T>
  
  Data type to clone to
Returns T
Cloned data object
Inherited from DataObject.clone
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:139

getPosition

getPosition(referenceSpace?): AbsolutePosition
Get the current absolute position of the object
Parameters
- Optional referenceSpace: TransformationSpace
  
  Reference space to transform it to
Returns AbsolutePosition
Position of the data object
Inherited from DataObject.getPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:72

getRelativePosition

getRelativePosition(referenceObjectUID, type?): RelativePosition<any, Unit>
Get relative position of a specified object
Parameters
- referenceObjectUID: string
  
  Reference object identifier
- Optional type: string
  
  Constructor type of the relative position
Returns RelativePosition<any, Unit>
Relative position to reference object
Inherited from DataObject.getRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:124

getRelativePositions

getRelativePositions(referenceObjectUID?): RelativePosition<any, Unit>[]
Get relative positions for a different target
Parameters
- Optional referenceObjectUID: string
  
  Reference object identifier
Returns RelativePosition<any, Unit>[]
Array of relative positions for the reference object
Inherited from DataObject.getRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:116

hasRelativePosition

hasRelativePosition(referenceObjectUID): boolean
Parameters
- referenceObjectUID: string
Returns boolean
Inherited from DataObject.hasRelativePosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:125

removeRelativePositions

removeRelativePositions(referenceObjectUID): void
Parameters
- referenceObjectUID: string
Returns void
Inherited from DataObject.removeRelativePositions
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:102

setParent

setParent(object): SolidProfileObject
Set a parent object to the data object
Parameters
- object: string | DataObject
  
  Data object or UID to add as parent
Returns SolidProfileObject
instance
Inherited from DataObject.setParent
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:101

setPosition

setPosition(position, referenceSpace?): SolidProfileObject
Set the current absolute position of the object
Parameters
- position: AbsolutePosition
  
  Position to set
- Optional referenceSpace: TransformationSpace
  
  Reference space
Returns SolidProfileObject
Data object instance
Inherited from DataObject.setPosition
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:80

setUID

setUID(uid): SolidProfileObject
Set the unique identifier of this object
Parameters
- uid: string
  
  Unique Identifier
Returns SolidProfileObject
Data object instance
Inherited from DataObject.setUID
- Defined in node_modules/@openhps/core/dist/types/data/object/DataObject.d.ts:87

Class SolidProfileObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional webId: string

Returns SolidProfileObject

Properties

createdTimestamp

displayName

oidcIssuer

parentUID

sessionId

uid

Returns

Accessors

position

Returns AbsolutePosition

Parameters

position: AbsolutePosition

Returns void

profileDocumentUrl

Returns URL

relativePositions

Returns RelativePosition<any, Unit>[]

Parameters

relativePostions: RelativePosition<any, Unit>[]

Returns void

webId

Returns string

Parameters

value: string

Returns void

Methods

addRelativePosition

Parameters

relativePosition: RelativePosition<any, Unit>

Returns SolidProfileObject

bind

Parameters

service: DataService<string, SolidProfileObject>

Returns DataObjectBinding<SolidProfileObject>

clone

Type Parameters

T extends SolidProfileObject<T>

Parameters

Optional dataType: Constructor<T>

Returns T

getPosition

Parameters

Optional referenceSpace: TransformationSpace

Returns AbsolutePosition

getRelativePosition

Parameters

referenceObjectUID: string

Optional type: string

Returns RelativePosition<any, Unit>

getRelativePositions

Parameters

Optional referenceObjectUID: string

Returns RelativePosition<any, Unit>[]

hasRelativePosition

Parameters

referenceObjectUID: string

Returns boolean

removeRelativePositions

Parameters

referenceObjectUID: string

Returns void

setParent

Parameters

object: string | DataObject

Returns SolidProfileObject

setPosition

Parameters

`Optional` webId: string

`Optional` dataType: Constructor<T>

`Optional` referenceSpace: TransformationSpace

`Optional` type: string

`Optional` referenceObjectUID: string

`Optional` referenceSpace: TransformationSpace