Carbon LDP JavaScript SDK API Reference

Exported Elements




Classes

C
CarbonLDP.AbstractContext
Abstract class for defining contexts.




Implements:

Abstract class for defining contexts.


Constructor


AbstractContext( parentContext?:P ):void

Param Type Default Description
parentContext P

Properties

.baseURI
: string

The base URI of the context. To be defined by the subclass.


.parentContext
: P

The parent context provided in the constructor. Empty if not provided in constructor


.registry
: CarbonLDP.AbstractRegistry<M, CarbonLDP.AbstractContext<M, P>>

Registry that stores the pointers of the current in accordance to the its base URI. To be defined by the subclass.


Methods

.clearObjectSchema()
: void


clearObjectSchema( type?:string ):void

Remove the schema of the type specified, or the general schema if no type is provided.


Param Type Default Description
type string

The URI of the type to remove its schema.



.extendObjectSchema()
: void


extendObjectSchema( type:string, objectSchema:CarbonLDP.DigestedObjectSchema ):void

Extends the schema for a specified type of Resource. If a schema for the type exists in the parent context, this is duplicated for the actual context, but only the first time this schema is extended.


Param Type Default Description
type string

The URI of the type to extends its schema.

objectSchema CarbonLDP.DigestedObjectSchema

The new schema that will extends the previous one.



extendObjectSchema( objectSchema:CarbonLDP.DigestedObjectSchema ):void

Extends the general schema of the current context. If a general schema exists in the parent context, this is duplicated for the current context, but only the first time the schema is extended.


Param Type Default Description
objectSchema CarbonLDP.DigestedObjectSchema

The new schema that will extends the previous one.



.getObjectSchema()
: CarbonLDP.DigestedObjectSchema


getObjectSchema( type?:string ):CarbonLDP.DigestedObjectSchema

Returns the ObjectSchema for the specified type


Param Type Default Description
type string

The URI of the type to look for its schema.



getObjectSchema():CarbonLDP.DigestedObjectSchema

Returns the general object schema of the context.




.hasObjectSchema()
: boolean


hasObjectSchema( type:string ):boolean

Returns true if there is an ObjectSchema for the specified type.


Param Type Default Description
type string

The URI of the type to look for its schema.



.resolve()
: string


resolve( relativeURI:string ):string

Abstract method that returns an absolute URI in accordance to the context scope.


Param Type Default Description
relativeURI string




Interfaces

I
CarbonLDP.TransientAccessPoint
Interface that represents the document of an in-memory access point.
I
CarbonLDP.TransientAccessPointFactory
Interface with the factory, decorate and utils methods of a CarbonLDP.TransientAccessPointFactory object.

Properties




Interface that represents the document of an in-memory access point.


Properties

.hasMemberRelation
: CarbonLDP.Pointer

Pointer that represents the member relation that the access point will manage.


.insertedContentRelation
: CarbonLDP.Pointer

Pointer that represents the inserted content relation of the access point.


.isMemberOfRelation
: CarbonLDP.Pointer

Pointer that represents the inverted relation that the access point will create.





Interface with the factory, decorate and utils methods of a CarbonLDP.TransientAccessPointFactory object.


Properties

Methods

.create()
: CarbonLDP.TransientAccessPoint


create<T extends object>( data:T & CarbonLDP.BaseAccessPoint ):CarbonLDP.TransientAccessPoint

Creates a CarbonLDP.TransientAccessPoint object with the parameters specified.


Param Type Default Description
data T & CarbonLDP.BaseAccessPoint

Data necessary to create an access point.



.createFrom()
: T & CarbonLDP.TransientAccessPoint


createFrom<T extends object>( object:T & CarbonLDP.BaseAccessPoint ):T & CarbonLDP.TransientAccessPoint

Creates a CarbonLDP.TransientAccessPoint object from the object and parameters specified.


Param Type Default Description
object T & CarbonLDP.BaseAccessPoint

Object that will be converted into an AccessPoint.



.is()
: value is CarbonLDP.TransientAccessPoint


is( value:any ):value is CarbonLDP.TransientAccessPoint

Returns true if the object provided is considered a CarbonLDP.TransientAccessPoint object


Param Type Default Description
value any




Classes

C
CarbonLDP
The main class of the SDK, which contains all the references of the modules used in the the SDK.




CarbonLDP
Class

The main class of the SDK, which contains all the references of the modules used in the the SDK.


Reexports


Constructor


CarbonLDP( url:string ):void

Param Type Default Description
url string

The URL where the platform instance is located on.



CarbonLDP( settings:CarbonLDP.SettingsCarbonSettings ):void

Param Type Default Description
settings CarbonLDP.SettingsCarbonSettings

A settings object to fully configure the Carbon instance.


Properties

#version
: string

Returns the version of the SDK.


.baseURI
: string

Returns the URI of your Carbon LDP.


.documents
: CarbonLDP.Document

Representation of the root document of the platform instance.


.registry
: CarbonLDP.DocumentsRegistry

Registry that stores the documents of a Carbon LDP instance.


.version
: string

Returns the version of the SDK.


Methods

.getPlatformMetadata()
: Promise<CarbonLDP.System.PlatformMetadata>


getPlatformMetadata():Promise<CarbonLDP.System.PlatformMetadata>

Retrieves the Metadata related to the Carbon LDP Platform.




.resolve()
: string


resolve( relativeURI:string ):string

Resolve the URI provided in the scope your Carbon LDP Platform instance.


Param Type Default Description
relativeURI string

Relative URI to be resolved.





Interfaces

I
CarbonLDP.CarbonLDPSettings
Interface of the possible settings used by the Carbon class.




Interface of the possible settings used by the Carbon class.


Properties

.host
: string

The host of the platform to connect to.


.post
: number

The optional port of the host to connect to.


.ssl
: boolean

Flag that indicates is the server is under a secure connection or not. By default it will be set to true, making the host to be resolved as https://





Interfaces

I
CarbonLDP.DocumentPaths
Interface that describe the paths inside a respective document
I
CarbonLDP.DocumentsContextSettings
Interface of the possible settings of a DocumentsContext.
I
CarbonLDP.Paths
Interface that describe the key path key and its respective URI slug of another CarbonLDP.DocumentPath of a child document.




Interface that describe the paths inside a respective document


Properties

.paths
: CarbonLDP.Paths


.slug
: string





Interface of the possible settings of a DocumentsContext.


Properties




CarbonLDP.Paths
Interface

Interface that describe the key path key and its respective URI slug of another CarbonLDP.DocumentPath of a child document.


Properties

.[ document:string ]
: string | DocumentPaths





Interfaces

I
CarbonLDP.TransientDocument
Interface that represents an in-memory Carbon LDP Document.
I
CarbonLDP.TransientDocumentFactory
Interface with the factory, decorate and utils for CarbonLDP.TransientDocument objects.

Properties




Interface that represents an in-memory Carbon LDP Document.


Properties

.defaultInteractionModel
: CarbonLDP.Pointer

A Pointer URI representing the default interaction model of the document when persisted.


.hasMemberRelation
: CarbonLDP.Pointer

A Pointer with the member of relation of the document.


.insertedContentRelation
: CarbonLDP.Pointer

Pointer that represents the inserted content relation of the document.


.isMemberOfRelation
: CarbonLDP.Pointer

A Pointer with the inverted relation the document will have.


Methods

.$_normalize()
: void


$_normalize():void

Search over the document for normal objects to convert into fragments, and unused fragments to eliminate.




.$createFragment()
: T & CarbonLDP.TransientFragment


$createFragment<T>( object:T, id?:string ):T & CarbonLDP.TransientFragment

Creates a CarbonLDP.TransientFragment from the object provided and the id if specified.


Param Type Default Description
object T
id string


$createFragment( id:string ):CarbonLDP.TransientFragment

Creates an empty CarbonLDP.TransientFragment with the id specified.


Param Type Default Description
id string


.$getFragment()
: T & CarbonLDP.TransientFragment


$getFragment<T>( id:string ):T & CarbonLDP.TransientFragment

Returns the fragment referenced by the ID provided. Returns null if no fragment exists in the Document.


Param Type Default Description
id string


.$getFragments()
: CarbonLDP.TransientFragment[]


$getFragments():CarbonLDP.TransientFragment[]

Returns an array with all the fragments in the Document.




.$hasFragment()
: boolean


$hasFragment( id:string ):boolean

Returns true if the Document has the fragment referenced by the ID provided.


Param Type Default Description
id string


.$removeFragment()
: boolean


$removeFragment( fragment:CarbonLDP.TransientFragment ):boolean

Remove the fragment referenced by the CarbonLDP.TransientFragment provided from the Document.


Param Type Default Description
fragment CarbonLDP.TransientFragment


$removeFragment( slug:string ):boolean

Remove the fragment referenced by the Slug provided from the Document.


Param Type Default Description
slug string


.toJSON()
: CarbonLDP.RDF.RDFDocument


toJSON():CarbonLDP.RDF.RDFDocument

Returns a JSON-LD Document using the data available from the $registry of the document.




toJSON( context:CarbonLDP.Context ):CarbonLDP.RDF.RDFDocument

Returns a JSON-LD Document using the data context provided.


Param Type Default Description
context CarbonLDP.Context










Context that manages the CarbonLDP.Documents objects.


Constructor


DocumentsContext( url:string, settings?:CarbonLDP.ContextSettings ):void

Param Type Default Description
url string

The base URL of the context.

settings CarbonLDP.ContextSettings

Customizable settings of the context


Properties

Methods







Registry that stores Document object.


Properties

Methods

.registry()
: CarbonLDP.Document


registry( id:string ):CarbonLDP.Document

Param Type Default Description
id string

ID of the document to be registered in the registry.











Documents repository.


Properties

Methods

.delete()
: Promise<void>


delete( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Delete the resource referred by the URI provided from the server.


Param Type Default Description
uri string

The resource to be deleted.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.exists()
: Promise<boolean>


exists( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<boolean>

Param Type Default Description
uri string

The URI to verify if its existence.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.get()
: Promise<T & CarbonLDP.Document>


get<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.GETOptions ):Promise<T & CarbonLDP.Document>

Retrieves the entire specified document.


Param Type Default Description
uri string

The URI of the document to retrieve.

requestOptions CarbonLDP.HTTP.GETOptions

Customizable options for the request.



get<T extends object>( uri:string, queryBuilderFn:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Retrieves the specified properties and sub-properties of the URI specified by the function provided.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



get<T extends object>( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Retrieves the selected properties and sub-properties of a query builder function provided.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



.refresh()
: Promise<T & CarbonLDP.Document>


refresh<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Refresh the full or partial document.


Param Type Default Description
document CarbonLDP.Document

The document to be refreshed.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.resolve()
: Promise<T & CarbonLDP.Document>


resolve<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.GETOptions ):Promise<T & CarbonLDP.Document>

Resolves the entire specified document.


Param Type Default Description
uri string

The URI of the document to retrieve.

requestOptions CarbonLDP.HTTP.GETOptions

Customizable options for the request.



resolve<T extends object>( uri:string, queryBuilderFn:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Resolves the specified properties and sub-properties of the URI specified by the function provided.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



resolve<T extends object>( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Resolves the selected properties and sub-properties of a query builder function provided.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



.save()
: Promise<T & CarbonLDP.Document>


save<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Send the changes of the document.


Param Type Default Description
document CarbonLDP.Document

The document to be saved.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.saveAndRefresh()
: Promise<T & CarbonLDP.Document>


saveAndRefresh<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Send the changes of the document and retrieves the updated data from the server.


Param Type Default Description
document CarbonLDP.Document

The document to be saved.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.











Documents repository with the implementation for event subscriptions.


Properties

Methods

.$off()
: void


$off( event:CarbonLDP.Messaging.Event.CHILD_CREATED, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Remove a subscription that contains the document event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event of the subscription to remove.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.CHILD_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED, onEvent:( message:CarbonLDP.Messaging.AccessPointCreated ) => void, onError:( error:Error ) => void ):void

Remove a subscription that contains the document event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED

The event of the subscription to remove.

onEvent ( message:CarbonLDP.Messaging.AccessPointCreated ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.AccessPointCreated ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.AccessPointCreated ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Remove a subscription that contains the document event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event of the subscription to remove.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Remove a subscription that contains the document event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event of the subscription to remove.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Remove a subscription that contains the document event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event of the subscription to remove.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Remove a subscription that contains the document event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event of the subscription to remove.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event | string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Remove a subscription that contains the document event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event of the subscription to remove.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



$off( event:CarbonLDP.Messaging.Event | string, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



.$on()
: void


$on( event:CarbonLDP.Messaging.Event.CHILD_CREATED, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified document event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event to subscribe for its notifications.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.CHILD_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED, onEvent:( message:CarbonLDP.Messaging.AccessPointCreated ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified document event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED

The event to subscribe for its notifications.

onEvent ( message:CarbonLDP.Messaging.AccessPointCreated ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.AccessPointCreated ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.AccessPointCreated ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified document event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event to subscribe for its notifications.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified document event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event to subscribe for its notifications.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified document event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event to subscribe for its notifications.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified document event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event to subscribe for its notifications.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event | string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified document event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event to subscribe for its notifications.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$on( event:CarbonLDP.Messaging.Event | string, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



.$onChildCreated()
: void


$onChildCreated( onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.CHILD_CREATED event notifications for the document.


Param Type Default Description
onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



$onChildCreated( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.CHILD_CREATED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.$onDocumentDeleted()
: void


$onDocumentDeleted( onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.DOCUMENT_DELETED event notifications for the document.


Param Type Default Description
onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



$onDocumentDeleted( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.DOCUMENT_DELETED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.$onDocumentModified()
: void


$onDocumentModified( onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED event notifications for the document.


Param Type Default Description
onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



$onDocumentModified( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.$onMemberAdded()
: void


$onMemberAdded( onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.MEMBER_ADDED event notifications for the document.


Param Type Default Description
onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



$onMemberAdded( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.MEMBER_ADDED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.$onMemberRemoved()
: void


$onMemberRemoved( onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.MEMBER_REMOVED event notifications for the document.


Param Type Default Description
onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



$onMemberRemoved( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.MEMBER_REMOVED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.$one()
: void


$one( event:CarbonLDP.Messaging.Event.CHILD_CREATED, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the document event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event to subscribe for one notification.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.CHILD_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED, onEvent:( message:CarbonLDP.Messaging.AccessPointCreated ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the document event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED

The event to subscribe for one notification.

onEvent ( message:CarbonLDP.Messaging.AccessPointCreated ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.AccessPointCreated ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.ACCESS_POINT_CREATED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.AccessPointCreated ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the document event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event to subscribe for one notification.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the document event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event to subscribe for one notification.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the document event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event to subscribe for one notification.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the document event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event to subscribe for one notification.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event | string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the document event provided


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event to subscribe for one notification.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



$one( event:CarbonLDP.Messaging.Event | string, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.











Documents repository with the implementation for event subscriptions.


Properties

Methods

.off()
: void


off( event:CarbonLDP.Messaging.Event.CHILD_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



off( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



off( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



off( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



off( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



off( event:CarbonLDP.Messaging.Event | string, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Remove the subscription specified by the uri pattern, event and onEvent callback provided.


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event of the subscription to remove.

uriPattern string

URI and/or pattern of the resource(s) to unsubscribe for.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

The onEvent callback of the subscription to be removed. It must be the same call back provided in the on methods.

onError ( error:Error ) => void

Callback that receives the error thrown trying to remove the subscription.



.on()
: void


on( event:CarbonLDP.Messaging.Event.CHILD_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



on( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



on( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



on( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



on( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



on( event:CarbonLDP.Messaging.Event | string, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Subscribe to the specified uri pattern event notifications.


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event to subscribe for its notifications.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



.onChildCreated()
: void


onChildCreated( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.CHILD_CREATED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.onDocumentDeleted()
: void


onDocumentDeleted( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.DOCUMENT_DELETED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.onDocumentModified()
: void


onDocumentModified( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.onMemberAdded()
: void


onMemberAdded( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.MEMBER_ADDED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.onMemberRemoved()
: void


onMemberRemoved( uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to the CarbonLDP.Messaging.Event.MEMBER_REMOVED event notifications for the uri pattern specified.


Param Type Default Description
uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback thar receives the errors thrown by the subscription.



.one()
: void


one( event:CarbonLDP.Messaging.Event.CHILD_CREATED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.CHILD_CREATED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.ChildCreatedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



one( event:CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentModifiedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



one( event:CarbonLDP.Messaging.Event.DOCUMENT_DELETED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.DOCUMENT_DELETED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.DocumentDeletedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



one( event:CarbonLDP.Messaging.Event.MEMBER_ADDED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberAddedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_ADDED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberAddedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



one( event:CarbonLDP.Messaging.Event.MEMBER_REMOVED, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event.MEMBER_REMOVED

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.MemberRemovedEvent ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.



one( event:CarbonLDP.Messaging.Event | string, uriPattern:string, onEvent:( message:CarbonLDP.Messaging.EventMessage ) => void, onError:( error:Error ) => void ):void

Subscribe to only one notification to the uri pattern and event provided


Param Type Default Description
event CarbonLDP.Messaging.Event | string

The event to subscribe for one notification.

uriPattern string

URI and/or pattern of the resource(s) to subscribe for.

onEvent ( message:CarbonLDP.Messaging.EventMessage ) => void

Callback that receives the data message from the notification event.

onError ( error:Error ) => void

Callback that receives the errors thrown by the subscription.











Repository trait with general HTTP requests


Properties

.$context
: CarbonLDP.Context<MODEL & RegisteredPointer, MODEL>











Documents repository with the implementation for event subscriptions.


Properties

Methods

.$addMember()
: Promise<void>


$addMember( member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Adds the provided resource as member of the current document.


Param Type Default Description
member CarbonLDP.Pointer | string

URI or Pointer to add as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$addMember( uri:string, member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Adds the provided resource as member of the specified document.


Param Type Default Description
uri string

URI of the document to add the specified member.

member CarbonLDP.Pointer | string

URI or Pointer to add as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.$addMembers()
: Promise<void>


$addMembers( member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Adds the provided resources as members of the current document.


Param Type Default Description
member CarbonLDP.Pointer | string

URI or Pointer to add as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$addMembers( uri:string, member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Adds the provided resources as members of the specified document.


Param Type Default Description
uri string

URI of the document to add the specified member.

member CarbonLDP.Pointer | string

URI or Pointer to add as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.$create()
: Promise<T & CarbonLDP.Document>


$create<T extends object>( child:T, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object as a child of the current document.


Param Type Default Description
child T

The object from where to create the child.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$create<T extends object>( child:T, slug:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object with the slug specified as a child of the current document.


Param Type Default Description
child T

The object from where to create the child.

slug string

The slug that will be used in the child URI.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$create<T extends object>( children:T[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the current document.


Param Type Default Description
children T[]

An array with the objects to be persisted as the new children.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



$create<T extends object>( children:T[], slugs:string[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the current document.


Param Type Default Description
children T[]

An array with the objects to be persisted as the new children.

slugs string[]

Array with the slugs that corresponds to each object in object parameter, in the order in which they were defined. If an element in the array is undefined or null, the slug will be generated by the platform.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



$create<T extends object>( uri:string, child:T, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object as a child of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$create<T extends object>( uri:string, child:T, slug:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object with the slug specified as a child of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

slug string

The slug that will be used in the child URI.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$create<T extends object>( uri:string, children:T[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



$create<T extends object>( uri:string, children:T[], slugs:string[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

slugs string[]

Array with the slugs that corresponds to each object in object parameter, in the order in which they were defined. If an element in the array is undefined or null, the slug will be generated by the platform.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



.$createAndRetrieve()
: Promise<T & CarbonLDP.Document>


$createAndRetrieve<T extends object>( child:T, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object as a child of the current document and retrieves the updated data from the server.


Param Type Default Description
child T

The object from where to create the child.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$createAndRetrieve<T extends object>( child:T, slug:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object with the slug specified as a child of the current document and retrieves the updated data from the server.


Param Type Default Description
child T

The object from where to create the child.

slug string

The slug that will be used in the child URI.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$createAndRetrieve<T extends object>( children:T[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the current document and retrieves the updated data from the server.


Param Type Default Description
children T[]

An array with the objects to be persisted as the new children.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



$createAndRetrieve<T extends object>( children:T[], slugs:string[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the current document and retrieves the updated data from the server.


Param Type Default Description
children T[]

An array with the objects to be persisted as the new children.

slugs string[]

Array with the slugs that corresponds to each object in object parameter, in the order in which they were defined. If an element in the array is undefined or null, the slug will be generated by the platform.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



$createAndRetrieve<T extends object>( uri:string, child:T, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object as a child of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$createAndRetrieve<T extends object>( uri:string, child:T, slug:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object with the slug specified as a child of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

slug string

The slug that will be used in the child URI.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$createAndRetrieve<T extends object>( uri:string, children:T[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



$createAndRetrieve<T extends object>( uri:string, children:T[], slugs:string[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

slugs string[]

Array with the slugs that corresponds to each object in object parameter, in the order in which they were defined. If an element in the array is undefined or null, the slug will be generated by the platform.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



.$removeMember()
: Promise<void>


$removeMember( member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Removes the provided resource as member of the current document.


Param Type Default Description
member CarbonLDP.Pointer | string

URI or Pointer to remove as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$removeMember( uri:string, member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Removes the provided resource as member of the specified document.


Param Type Default Description
uri string

URI of the document to remove the specified member.

member CarbonLDP.Pointer | string

URI or Pointer to remove as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.$removeMembers()
: Promise<void>


$removeMembers( member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Removes the provided resources as members of the current document.


Param Type Default Description
member CarbonLDP.Pointer | string

URI or Pointer to remove as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$removeMembers( uri:string, member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Removes the provided resources as members of the specified document.


Param Type Default Description
uri string

URI of the document to remove the specified member.

member CarbonLDP.Pointer | string

URI or Pointer to remove as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.











Documents repository with the implementation for sparql queries.


Properties

Methods

.addMember()
: Promise<void>


addMember( uri:string, member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Adds the provided resource as member of the specified document.


Param Type Default Description
uri string

URI of the document to add the specified member.

member CarbonLDP.Pointer | string

URI or Pointer to add as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.addMembers()
: Promise<void>


addMembers( uri:string, member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Adds the provided resources as members of the specified document.


Param Type Default Description
uri string

URI of the document to add the specified member.

member CarbonLDP.Pointer | string

URI or Pointer to add as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.create()
: Promise<T & CarbonLDP.Document>


create<T extends object>( uri:string, child:T, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object as a child of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



create<T extends object>( uri:string, child:T, slug:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object with the slug specified as a child of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

slug string

The slug that will be used in the child URI.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



create<T extends object>( uri:string, children:T[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



create<T extends object>( uri:string, children:T[], slugs:string[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

slugs string[]

Array with the slugs that corresponds to each object in object parameter, in the order in which they were defined. If an element in the array is undefined or null, the slug will be generated by the platform.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



.createAndRetrieve()
: Promise<T & CarbonLDP.Document>


createAndRetrieve<T extends object>( uri:string, child:T, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object as a child of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



createAndRetrieve<T extends object>( uri:string, child:T, slug:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Persists the object with the slug specified as a child of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

child T

The object from where to create the child.

slug string

The slug that will be used in the child URI.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



createAndRetrieve<T extends object>( uri:string, children:T[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



createAndRetrieve<T extends object>( uri:string, children:T[], slugs:string[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Persists multiple objects as children of the uri specified and retrieves the updates data from the server.


Param Type Default Description
uri string

URI of the document where to create the child.

children T[]

An array with the objects to be persisted as the new children.

slugs string[]

Array with the slugs that corresponds to each object in object parameter, in the order in which they were defined. If an element in the array is undefined or null, the slug will be generated by the platform.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for every the request.



.delete()
: Promise<void>


delete( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Delete the resource referred by the URI provided from the server.


Param Type Default Description
uri string

The resource to be deleted.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.exists()
: Promise<boolean>


exists( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<boolean>

Param Type Default Description
uri string

The URI to verify if its existence.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.get()
: Promise<T & CarbonLDP.Document>


get<T extends object>( uri:string, requestOptions?:CarbonLDP.HTTP.GETOptions ):Promise<T & CarbonLDP.Document>

Param Type Default Description
uri string

The URI of the resource to retrieve.

requestOptions CarbonLDP.HTTP.GETOptions

Customizable options for the request.



.refresh()
: Promise<T & CarbonLDP.Document>


refresh<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Update the document with the latest changes from the server.


Param Type Default Description
document CarbonLDP.Document

The document to be refreshed.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.removeMember()
: Promise<void>


removeMember( uri:string, member:CarbonLDP.Pointer | string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Removes the provided resource as member of the specified document.


Param Type Default Description
uri string

URI of the document to remove the specified member.

member CarbonLDP.Pointer | string

URI or Pointer to remove as a member.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.removeMembers()
: Promise<void>


removeMembers( uri:string, members?:(CarbonLDP.Pointer | string)[], requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Removes the provided resources as members of the specified document. If no members provided, all the available members will be removed.


Param Type Default Description
uri string

URI of the document to remove the specified member.

members (CarbonLDP.Pointer | string)[]

URIs or Pointers to remove as a members.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.resolve()
: Promise<T & CarbonLDP.Document>


resolve<T extends object>( document:CarbonLDP.Document, requestOptions:CarbonLDP.HTTP.GETOptions ):Promise<T & CarbonLDP.Document>

Param Type Default Description
document CarbonLDP.Document

The document to be resolved.

requestOptions CarbonLDP.HTTP.GETOptions

Customizable options for the request.



.save()
: Promise<T & CarbonLDP.Document>


save<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Send the changes of the document to the server.


Param Type Default Description
document CarbonLDP.Document

The document to be saved.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.saveAndRefresh()
: Promise<T & CarbonLDP.Document>


saveAndRefresh<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Send the changes of the document and retrieves the updated data from the server.


Param Type Default Description
document CarbonLDP.Document

The document to be saved.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.











Documents repository with the implementation for event subscriptions.


Properties

Methods

.$getChildren()
: Promise<(T & CarbonLDP.Document)[]>


$getChildren<T extends object>( requestOptions:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the children of the current document, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the children retrieval query. The same builder must be returned.



$getChildren<T extends object>( queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the children of the current document, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the children retrieval query. The same builder must be returned.



$getChildren<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the children of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the children retrieval query. The same builder must be returned.



$getChildren<T extends object>( uri:string, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the children of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the children retrieval query. The same builder must be returned.



.$getMembers()
: Promise<(T & CarbonLDP.Document)[]>


$getMembers<T extends object>( requestOptions:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the members of the current document, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the members retrieval query. The same builder must be returned.



$getMembers<T extends object>( queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the members of the current document, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the members retrieval query. The same builder must be returned.



$getMembers<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the members of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the members retrieval query. The same builder must be returned.



$getMembers<T extends object>( uri:string, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the members of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the members retrieval query. The same builder must be returned.



.$listChildren()
: Promise<(T & CarbonLDP.Document)[]>


$listChildren<T extends object>( requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the empty children of the current document


Param Type Default Description
requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$listChildren<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the empty children of the specified URI.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.$listMembers()
: Promise<(T & CarbonLDP.Document)[]>


$listMembers<T extends object>( requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the empty members of the current document


Param Type Default Description
requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$listMembers<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the empty members of the specified URI.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.











Documents repository with the implementation for sparql queries.


Properties

Methods

.get()
: Promise<T & CarbonLDP.Document>


get<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.GETOptions ):Promise<T & CarbonLDP.Document>

Retrieves the entire specified document.


Param Type Default Description
uri string

The URI of the document to retrieve.

requestOptions CarbonLDP.HTTP.GETOptions

Customizable options for the request.



get<T extends object>( uri:string, queryBuilderFn:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Retrieves the specified properties and sub-properties of the URI specified by the function provided.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



get<T extends object>( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Retrieves the selected properties and sub-properties of a query builder function provided.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



.getChildren()
: Promise<(T & CarbonLDP.Document)[]>


getChildren<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the children of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the children retrieval query. The same builder must be returned.



getChildren<T extends object>( uri:string, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the children of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the children retrieval query. The same builder must be returned.



.getMembers()
: Promise<(T & CarbonLDP.Document)[]>


getMembers<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the members of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the members retrieval query. The same builder must be returned.



getMembers<T extends object>( uri:string, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the members of the specified URI, building a query on which one is able to specify the properties to be retrieve and sub-documents' properties and on and on.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentsBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentsBuilder

Function that receives a the builder that helps you to construct the members retrieval query. The same builder must be returned.



.listChildren()
: Promise<(T & CarbonLDP.Document)[]>


listChildren<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the empty children of the specified URI.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.listMembers()
: Promise<(T & CarbonLDP.Document)[]>


listMembers<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):Promise<(T & CarbonLDP.Document)[]>

Retrieves the empty members of the specified URI.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.refresh()
: Promise<T & CarbonLDP.Document>


refresh<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Refresh the full or partial document.


Param Type Default Description
document CarbonLDP.Document

The document to be refreshed.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.resolve()
: Promise<T & CarbonLDP.Document>


resolve<T extends object>( uri:string, requestOptions:CarbonLDP.HTTP.GETOptions ):Promise<T & CarbonLDP.Document>

Resolves the entire specified document.


Param Type Default Description
uri string

The URI of the document to retrieve.

requestOptions CarbonLDP.HTTP.GETOptions

Customizable options for the request.



resolve<T extends object>( uri:string, queryBuilderFn:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Resolves the specified properties and sub-properties of the URI specified by the function provided.


Param Type Default Description
uri string

The URI of the document to query.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



resolve<T extends object>( uri:string, requestOptions?:CarbonLDP.HTTP.RequestOptions, queryBuilderFn?:( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder ):Promise<T & CarbonLDP.Document>

Resolves the selected properties and sub-properties of a query builder function provided.


Param Type Default Description
uri string

The URI of the document to query.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.

queryBuilderFn ( queryBuilder:CarbonLDP.QueryDocuments.QueryDocumentBuilder ) => CarbonLDP.QueryDocuments.QueryDocumentBuilder

Function that receives a the builder that helps you to construct the retrieval query. The same builder must be returned.



.saveAndRefresh()
: Promise<T & CarbonLDP.Document>


saveAndRefresh<T extends object>( document:CarbonLDP.Document, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<T & CarbonLDP.Document>

Send the changes of the document and retrieves the updated data from the server.


Param Type Default Description
document CarbonLDP.Document

The document to be saved.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.











Documents repository with the implementation for event subscriptions.


Properties

Methods

.$executeASKQuery()
: Promise<boolean>


$executeASKQuery( uri:string, askQuery:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<boolean>

Executes an ASK query on a document and returns the response of the query in form of a boolean.


Param Type Default Description
uri string

URI of the document that works as a SPARQL endpoint where to execute the SPARQL query.

askQuery string

ASK query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$executeASKQuery( askQuery:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<boolean>

Executes an ASK query on the current document and returns the response of the query in form of a boolean.


Param Type Default Description
askQuery string

ASK query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.$executeSELECTQuery()
: Promise<CarbonLDP.SPARQL.SPARQLSelectResults<T>>


$executeSELECTQuery<T extends object>( uri:string, selectQuery:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<CarbonLDP.SPARQL.SPARQLSelectResults<T>>

Executes a SELECT query on a document and returns a parsed response object.


Param Type Default Description
uri string

URI of the document that works as a SPARQL endpoint where to execute the SPARQL query.

selectQuery string

SELECT query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$executeSELECTQuery<T extends object>( selectQuery:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<CarbonLDP.SPARQL.SPARQLSelectResults<T>>

Executes a SELECT query on the current document and returns a parsed response object.


Param Type Default Description
selectQuery string

SELECT query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.$executeUPDATE()
: Promise<void>


$executeUPDATE( uri:string, update:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Executes a DESCRIBE query on a document and returns a string with the resulting model.


Param Type Default Description
uri string

URI of the document that works as a SPARQL endpoint where to execute the SPARQL query.

update string

UPDATE query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



$executeUPDATE( update:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Executes a DESCRIBE query on the current document and returns a string with the resulting model.


Param Type Default Description
update string

UPDATE query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.$sparql()
: SPARQLER/Clauses/QueryClause<CarbonLDP.SPARQL.Builder.FinishSPARQLSelect>


$sparql( uri?:string ):SPARQLER/Clauses/QueryClause<CarbonLDP.SPARQL.Builder.FinishSPARQLSelect>

Method that creates an instance of SPARQLER for the specified document, or the current document if no URI is provided.


Param Type Default Description
uri string

URI of the document where to execute the SPARQL query.











Documents repository with the implementation for sparql queries.


Properties

Methods

.executeASKQuery()
: Promise<boolean>


executeASKQuery( uri:string, askQuery:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<boolean>

Executes an ASK query on a document and returns the response of the query in form of a boolean.


Param Type Default Description
uri string

URI of the document that works as a SPARQL endpoint where to execute the SPARQL query.

askQuery string

ASK query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.executeSELECTQuery()
: Promise<CarbonLDP.SPARQL.SPARQLSelectResults<T>>


executeSELECTQuery<T extends object>( uri:string, selectQuery:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<CarbonLDP.SPARQL.SPARQLSelectResults<T>>

Executes a SELECT query on a document and returns a parsed response object.


Param Type Default Description
uri string

URI of the document that works as a SPARQL endpoint where to execute the SPARQL query.

selectQuery string

SELECT query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.executeUPDATE()
: Promise<void>


executeUPDATE( uri:string, update:string, requestOptions?:CarbonLDP.HTTP.RequestOptions ):Promise<void>

Executes a DESCRIBE query on a document and returns a string with the resulting model.


Param Type Default Description
uri string

URI of the document that works as a SPARQL endpoint where to execute the SPARQL query.

update string

UPDATE query to execute in the selected endpoint.

requestOptions CarbonLDP.HTTP.RequestOptions

Customizable options for the request.



.sparql()
: SPARQLER/Clauses/QueryClause<CarbonLDP.SPARQL.Builder.FinishSPARQLSelect>


sparql( uri:string ):SPARQLER/Clauses/QueryClause<CarbonLDP.SPARQL.Builder.FinishSPARQLSelect>

Method that creates an instance of SPARQLER for the specified document URI.


Param Type Default Description
uri string

URI of the document where to execute the SPARQL query.











Classes

C
CarbonLDP.Errors.AbstractError
Class that works as template for the custom errors in the SDK.




Class that works as template for the custom errors in the SDK.


Constructor


AbstractError( message:string )

Param Type Default Description
message string

Properties

.message
: string


.name
: string





Classes

C
CarbonLDP.Errors.IDAlreadyInUseError
Error class to indicate that an identifier (ID) is already in use.




Error class to indicate that an identifier (ID) is already in use.


Properties

.name
: string





Classes

C
CarbonLDP.Errors.IllegalActionError
Error class to indicate that an action not allowed was attempted.




Error class to indicate that an action not allowed was attempted.


Properties

.name
: string





Classes

C
CarbonLDP.Errors.IllegalArgumentError
Error class to indicate that a different argument than the expected was provided.




Error class to indicate that a different argument than the expected was provided.


Properties

.name
: string





Classes

C
CarbonLDP.Errors.IllegalStateError
Error class to indicate that a task can't be completed because of the lack of pre-required configuration or execution of previous tasks.




Error class to indicate that a task can't be completed because of the lack of pre-required configuration or execution of previous tasks.


Constructor


IllegalStateError( message?:string )

Param Type Default Description
message string

Properties

.name
: string





Classes

C
CarbonLDP.Errors.InvalidJSONLDSyntaxError
Error class to indicate that there an invalid syntax in a JSON-LD object.




Error class to indicate that there an invalid syntax in a JSON-LD object.


Properties

.name
: string





Classes

C
CarbonLDP.Errors.NotImplementedError
Error class to indicate that an action is not yet implemented.




Error class to indicate that an action is not yet implemented.


Constructor


NotImplementedError( message?:string )

Param Type Default Description
message string

Properties

.name
: string





Interfaces

I
CarbonLDP.TransientFragment
Interface of an in-memory fragment of a document.
I
CarbonLDP.TransientFragmentFactory
Interface with the factory, decorate and utils methods of a CarbonLDP.TransientFragment object.

Properties




Interface of an in-memory fragment of a document.


Properties

.$document
: CarbonLDP.TransientDocument

The transient document where the transient fragment belongs to.


.$registry
: CarbonLDP.TransientDocument

The registry where the transient fragment belongs to.








Interfaces

I
CarbonLDP.FreeResources
Interface that represents a set of free resources.
I
CarbonLDP.FreeResourcesFactory
Interfaces with the factory, decorate and utils methods of a CarbonLDP.FreeResources object.

Properties




Interface that represents a set of free resources.


Properties

.registry
: CarbonLDP.GeneralRegistry<any>

The registry where the FreeResources scope is in.


Methods

.toJSON()
: CarbonLDP.RDF.RDFNode[]


toJSON():CarbonLDP.RDF.RDFNode[]

Returns a JSON-LD Node array using the data available from the registry of the current container.




toJSON( context:CarbonLDP.Context ):CarbonLDP.RDF.RDFNode[]

Returns a JSON-LD Node array using the data of context provided.


Param Type Default Description
context CarbonLDP.Context







Utils for CarbonLDP.FreeResources objects.


Methods

.parseFreeNodes()
: CarbonLDP.FreeResources


parseFreeNodes( registry:CarbonLDP.GeneralRegistry<any>, freeNodes:CarbonLDP.RDF.RDFNode[] ):CarbonLDP.FreeResources

Param Type Default Description
registry CarbonLDP.GeneralRegistry<any>
freeNodes CarbonLDP.RDF.RDFNode[]







Registry used by the context.


Properties

Methods

.addDecorator()
: this


addDecorator( decorator:TypedModelDecorator ):this

Param Type Default Description
decorator TypedModelDecorator


.decorate()
: void


decorate( object:{ types?:string[] } ):void

Param Type Default Description
object { types?:string[] }










Extends:

Repository used by a context.


Properties







Classes

C
CarbonLDP.GlobalContext
Base class of every Context in the SDK.




Extends:
CarbonLDP.AbstractContext<Pointer, undefined>

Base class of every Context in the SDK.


Constructor

Properties

#instance
: CarbonLDP.GlobalContext

The singleton for the GlobalContext. This is used as the parent context for every CarbonLDP instance.


.baseURI
: ""

An empty string since this context accepts any resource to be stored.


.parentContext
: undefined

Undefined since the singleton CarbonLDP.GlobalContext#instance is used as a parent context for every CarbonLDP context.


.registry
: CarbonLDP.PointerRegistry

Registry that stores simple pointers for any resource. This resources cannot be resolved since the GlobalContext does not have a repository.








Reexports


Properties

#statusCodeMap
: Map<number, typeof CarbonLDP.HTTP.Errors.HTTPError>

Map where all the HTTP Status Codes used in the SDK are assigned to their specific error class.





Classes

C
CarbonLDP.HTTP.Errors.BadRequestError
Error class to indicate that a malformed request has been sent.




Error class to indicate that a malformed request has been sent.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.ConflictError
Error class to indicate that the request could not be processed because of a conflict, such as an ID conflict.




Error class to indicate that the request could not be processed because of a conflict, such as an ID conflict.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.ForbiddenError
Error class to indicate that the current user doesn't have permissions to fulfill the request.




Error class to indicate that the current user doesn't have permissions to fulfill the request.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.MethodNotAllowedError
Error class to indicate that the method used in the request is not allowed for that URI.




Error class to indicate that the method used in the request is not allowed for that URI.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.NotAcceptableError
Error class to indicate that the server cannot respond with the data type specified by the accept header of the request.




Error class to indicate that the server cannot respond with the data type specified by the accept header of the request.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.NotFoundError
Error class to indicate that the resource was not found.




Error class to indicate that the resource was not found.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.PreconditionFailedError
Error class to indicate that the precondition header was resolved to false.




Error class to indicate that the precondition header was resolved to false.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.PreconditionRequiredError
Error class to indicate that the request is missing a precondition header.




Error class to indicate that the request is missing a precondition header.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.RequestEntityTooLargeError
Error class to indicate that the request entity is larger than the server is able to process.




Error class to indicate that the request entity is larger than the server is able to process.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.RequestHeaderFieldsTooLargeError
Error class to indicate that the server is not able to process the request because its header fields are too large.




Error class to indicate that the server is not able to process the request because its header fields are too large.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.RequestURITooLongError
Error class to indicate that the server is not able to process the request because the URI is too long.




Error class to indicate that the server is not able to process the request because the URI is too long.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.TooManyRequestsError
Error class to indicate that the current user has sent too many request in a given amount of time.




Error class to indicate that the current user has sent too many request in a given amount of time.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.UnauthorizedError
Error class to indicate that authentication is required or has failed.




Error class to indicate that authentication is required or has failed.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.UnsupportedMediaTypeError
Error class to indicate that the request has a media-type not supported by the server.




Error class to indicate that the request has a media-type not supported by the server.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.HTTPError
Generic error class that defines any type of HTTP Error used in the SDK.




Generic error class that defines any type of HTTP Error used in the SDK.


Constructor


HTTPError( message:string, response:CarbonLDP.HTTP.Response )

Param Type Default Description
message string
response CarbonLDP.HTTP.Response

Properties

#statusCode
: number


.name
: string


.response
: number


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.BadGatewayError
Error class to indicate that the server was acting as a gateway or proxy and received an invalid response from the upstream server.




Error class to indicate that the server was acting as a gateway or proxy and received an invalid response from the upstream server.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.BadResponseError
Error class to indicate that the response obtained isn't the expected or can't be interpreted.




Error class to indicate that the response obtained isn't the expected or can't be interpreted.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.GatewayTimeoutError
Error class to indicate that the server, while acting as a gateway or proxy, did not receive a timely response from the upstream server.




Error class to indicate that the server, while acting as a gateway or proxy, did not receive a timely response from the upstream server.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.HTTPVersionNotSupportedError
Error class to indicate that the server doesn't support the HTTP protocol version used in the request.




Error class to indicate that the server doesn't support the HTTP protocol version used in the request.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.InternalServerErrorError
Error class to indicate that the server encountered an unexpected condition. This generic error is given when no other specific error is suitable.




Error class to indicate that the server encountered an unexpected condition. This generic error is given when no other specific error is suitable.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.NotImplementedError
Error class to indicate that the server doesn't have the ability to fulfill the request yet.




Error class to indicate that the server doesn't have the ability to fulfill the request yet.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.ServiceUnavailableError
Error class to indicate that the server is currently unavailable (because it's overloaded or down for maintenance).




Error class to indicate that the server is currently unavailable (because it's overloaded or down for maintenance).


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.Errors.UnknownError
Error class that defines any error that could not be identified.




Error class that defines any error that could not be identified.


Properties

#statusCode
: number


.name
: string


Methods

.toString()
: string


toString():string





.HTTPMethod
: enum

Enum with the HTTP/1.1 methods.

Enumeration Description
CarbonLDP.HTTP.HTTPMethod.OPTIONS

Enum that identifies the OPTIONS HTTP/1.1 method, which allows the client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.

CarbonLDP.HTTP.HTTPMethod.HEAD

Enum that identifies the HEAD HTTP/1.1 method, which returns only the headers of a GET HTTP request.

CarbonLDP.HTTP.HTTPMethod.GET

Enum that identifies the GET HTTP/1.1 method, which returns whatever information is identified by the request URI.

CarbonLDP.HTTP.HTTPMethod.POST

Enum that identifies the POST HTTP/1.1 method, which requests to the server to create a new entity.

CarbonLDP.HTTP.HTTPMethod.PUT

Enum that identifies the PUT HTTP/1.1 method, which allows you to replace an entirely entity, or to send a signal to a resource.

CarbonLDP.HTTP.HTTPMethod.PATCH

Enum that identifies the PATCH HTTP/1.1 method, which allows you to update specified fields of an entity.

CarbonLDP.HTTP.HTTPMethod.DELETE

Enum that identifies the DELETE HTTP/1.1 method, which allows you to request the deletion of a resource identified by the request URI.




Classes

C
CarbonLDP.HTTP.Header
Class to manage the values in an HTTP header.




Class to manage the values in an HTTP header.


Constructor


Header( values?:string | string[] ):void

Param Type Default Description
values string | string[]

Properties

.values
: string[]

Array that contains each value of the header.


Methods

#parseHeaders()
: Map <string, CarbonLDP.HTTP.Header>


parseHeaders( headersString:string ):Map <string, CarbonLDP.HTTP.Header>

Returns a Map object which relates all header names with a CarbonLDP.HTTP.Header object containing their values.


Param Type Default Description
headersString string

.hasValue()
: boolean


hasValue( value:string ):boolean

Returns true if the values array contains the provided value.


Param Type Default Description
value string


.toString()
: string


toString():string





Classes

C
CarbonLDP.HTTP.JSONParser
Wrapper class for the native JSON.parse() function using the Promise pattern.




Implements:

Wrapper class for the native JSON.parse() function using the Promise pattern.


Methods

.parse()
: Promise<object>


parse( body:string ):Promise<object>

Param Type Default Description
body string

A JSON string to parse.





Interfaces

I
CarbonLDP.HTTP.Parser
Interface that represents a what a parser must contains to be used when converting the response of a request.




Interface that represents a what a parser must contains to be used when converting the response of a request.


Methods

.parse()
: Promise<T>


parse( body:string ):Promise<T>

Method that parse the provided string to an specified T element.


Param Type Default Description
body string

The string to parse.





Classes

C
CarbonLDP.HTTP.RequestService
Class with functions to easily manage HTTP requests.
C
CarbonLDP.HTTP.RequestUtils
Class with useful functions to manage the options object of a request.

Interfaces

I
CarbonLDP.HTTP.RequestOptions
Customizable options that can change the behaviour of the request.
I
CarbonLDP.HTTP.RetrievalPreferences
Object used at CarbonLDP.HTTP.RequestUtils#setRetrievalPreferences() method, which specifies the behaviour of the of the requested document as a ldp:container.




Customizable options that can change the behaviour of the request.


Properties

.headers
: Map<string, CarbonLDP.HTTP.Header>

Map that contains the references to the headers to include in the request.


.sendCredentialsOnCORS
: boolean

Flag that enables Cross-Origin Resource Sharing (CORS).





Class with functions to easily manage HTTP requests.


Methods

#delete()
: Promise<CarbonLDP.HTTP.Response>


delete( url:string, body:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Simple delete request.


Param Type Default Description
url string
body string
options object { sendCredentialsOnCORS: true }


delete( url:string, options?:object, parser?:CarbonLDP.HTTP.Parser<T> ):Promise<CarbonLDP.HTTP.Response>

Delete request with specified response parser.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }
parser CarbonLDP.HTTP.Parser<T>


delete( url:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Simple delete request.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }


delete( url:string, options?:object, parser?:CarbonLDP.HTTP.Parser<T> ):Promise<CarbonLDP.HTTP.Response>

Delete request with specified response parser.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }
parser CarbonLDP.HTTP.Parser<T>


#get()
: Promise<CarbonLDP.HTTP.Response>


get( url:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Simple get request.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }


get( url:string, options?:object, parser?:CarbonLDP.HTTP.Parser<T> ):Promise<[Object, CarbonLDP.HTTP.Response]>

Get request with specified response parser.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }
parser CarbonLDP.HTTP.Parser<T>


#head()
: Promise<CarbonLDP.HTTP.Response>


head( url:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }


#options()
: Promise<CarbonLDP.HTTP.Response>


options( url:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }


#patch()
: Promise<CarbonLDP.HTTP.Response>


patch( url:string, body:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Simple patch request.


Param Type Default Description
url string
body string
options object { sendCredentialsOnCORS: true }


patch( url:string, options?:object, parser?:CarbonLDP.HTTP.Parser<T> ):Promise<CarbonLDP.HTTP.Response>

Patch request with specified response parser.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }
parser CarbonLDP.HTTP.Parser<T>


#post()
: Promise<CarbonLDP.HTTP.Response>


post( url:string, body:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Simple post request.


Param Type Default Description
url string
body string
options object { sendCredentialsOnCORS: true }


post( url:string, options?:object, parser?:CarbonLDP.HTTP.Parser<T> ):Promise<CarbonLDP.HTTP.Response>

Post request with specified response parser.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }
parser CarbonLDP.HTTP.Parser<T>


#put()
: Promise<CarbonLDP.HTTP.Response>


put( url:string, body:string, options?:object ):Promise<CarbonLDP.HTTP.Response>

Simple put request.


Param Type Default Description
url string
body string
options object { sendCredentialsOnCORS: true }


put( url:string, options?:object, parser?:CarbonLDP.HTTP.Parser<T> ):Promise<CarbonLDP.HTTP.Response>

Put request with specified response parser.


Param Type Default Description
url string
options object { sendCredentialsOnCORS: true }
parser CarbonLDP.HTTP.Parser<T>


#send()
: Promise<CarbonLDP.HTTP.Response>


send( url:string, body:string, options:object ):Promise<CarbonLDP.HTTP.Response>

Generic send method, to be used by the others methods in the class.


Param Type Default Description
url string
body string
options object




Class with useful functions to manage the options object of a request.


Methods

#getHeader()
: CarbonLDP.HTTP.Header


getHeader( headerName:string, requestOptions:CarbonLDP.HTTP.RequestOptions, initialize?:boolean ):CarbonLDP.HTTP.Header

Returns the header object of a header-name inside an options object request. Returns undefined if the header doesn't exists. If initialize flag is provided with true, an empty header will be created even if it already exits.


Param Type Default Description
headerName string
requestOptions CarbonLDP.HTTP.RequestOptions
initialize boolean false


#isOptions()
: boolean


isOptions( object:Object ):boolean

Returns true if the object provided has at least a property of a CarbonLDP.HTTP.Request.Option object.


Param Type Default Description
object Object

The object to evaluate.



#setAcceptHeader()
: CarbonLDP.HTTP.RequestOptions


setAcceptHeader( accept:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):CarbonLDP.HTTP.RequestOptions

Set an Accept header in an options object request.


Param Type Default Description
accept string
requestOptions CarbonLDP.HTTP.RequestOptions


#setContentTypeHeader()
: CarbonLDP.HTTP.RequestOptions


setContentTypeHeader( contentType:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):CarbonLDP.HTTP.RequestOptions

Set a Content-Type header in an options object request.


Param Type Default Description
contentType string
requestOptions CarbonLDP.HTTP.RequestOptions


#setIfMatchHeader()
: CarbonLDP.HTTP.RequestOptions


setIfMatchHeader( eTag:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):CarbonLDP.HTTP.RequestOptions

Set an If-Match header in an options object request.


Param Type Default Description
eTag string
requestOptions CarbonLDP.HTTP.RequestOptions


#setIfNoneMatchHeader()
: Object


setIfNoneMatchHeader( eTag:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):Object

Set an If-None-Match header in an options object request.


Param Type Default Description
eTag string
requestOptions CarbonLDP.HTTP.RequestOptions


#setPreferredInteractionModel()
: CarbonLDP.HTTP.RequestOptions


setPreferredInteractionModel( interactionModelURI:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):CarbonLDP.HTTP.RequestOptions

Set a Prefer header with rel=interaction-model in an options object request.


Param Type Default Description
interactionModelURI string
requestOptions CarbonLDP.HTTP.RequestOptions


#setPreferredRetrieval()
: CarbonLDP.HTTP.RequestOptions


setPreferredRetrieval( retrievalType:"representation" | "minimal", requestOptions:CarbonLDP.HTTP.RequestOptions ):CarbonLDP.HTTP.RequestOptions

Set a Prefer header which indicates to the platform to type of retrieval to make.


Param Type Default Description
retrievalType "representation" | "minimal"

If "representation" is chosen the platform must retrieve the entire resource; otherwise when "minimal" is sent the minimal data will be returned generally an empty one.

requestOptions CarbonLDP.HTTP.RequestOptions


#setRetrievalPreferences()
: CarbonLDP.HTTP.RequestOptions


setRetrievalPreferences( preference:CarbonLDP.HTTP.RetrievalPreferences, requestOptions:CarbonLDP.HTTP.RequestOptions ):CarbonLDP.HTTP.RequestOptions

Set a Prefer header with return=representation in an options object request.


Param Type Default Description
preference CarbonLDP.HTTP.RetrievalPreferences
requestOptions CarbonLDP.HTTP.RequestOptions


#setSlug()
: CarbonLDP.HTTP.RequestOptions


setSlug( slug:string, requestOptions:CarbonLDP.HTTP.RequestOptions ):CarbonLDP.HTTP.RequestOptions

Set a Slug header in an options object request.


Param Type Default Description
slug string
requestOptions CarbonLDP.HTTP.RequestOptions




Object used at CarbonLDP.HTTP.RequestUtils#setRetrievalPreferences() method, which specifies the behaviour of the of the requested document as a ldp:container.


Properties

.include
: string[]

Prefer URIs that indicates some specific information should be returned in the request's response.


.omit
: string[]

Prefer URIs that indicates some specific information should NOT be included in the request's response.





Classes

C
CarbonLDP.HTTP.Response
Class that represents an HTTP Response.




Class that represents an HTTP Response.


Constructor


Response( request:XMLHttpRequest ):void

Signature that only works in a web browser.


Param Type Default Description
request XMLHttpRequest


Response( request:ClientRequest, data:string, response:IncomingMessage ):void

Signature that only works in Node.js.


Param Type Default Description
request ClientRequest
data string
response IncomingMessage

Properties

.data
: string

The raw body returned by the request.


.headers
: Map<string, CarbonLDP.HTTP.Header>

A map object containing the headers returned by the request.


.request
: XMLHttpRequest | ClientRequest

The XMLHttpRequest object that was provided in the constructor when working in a Browser, or the ClientRequest object when working with Node.js.


.status
: number

The status code returned by the request.


Methods

.getETag()
: string


getETag():string

Return the ETag header of a CarbonLDP.HTTP.Response object. Returns null if no ETag exists.




.getHeader()
: CarbonLDP.HTTP.Header


getHeader( name:string ):CarbonLDP.HTTP.Header

Return the Header object referred by the name specified.


Param Type Default Description
name string




.StatusCode
: enum

Enum with the HTTP/1.1 status codes.

Enumeration Description
CarbonLDP.HTTP.StatusCode.CONTINUE

Enum that identifies the HTTP/1.1 100 status code.

CarbonLDP.HTTP.StatusCode.SWITCHING_PROTOCOLS

Enum that identifies the HTTP/1.1 101 status code.

CarbonLDP.HTTP.StatusCode.OK

Enum that identifies the HTTP/1.1 200 status code.

CarbonLDP.HTTP.StatusCode.CREATED

Enum that identifies the HTTP/1.1 201 status code.

CarbonLDP.HTTP.StatusCode.ACCEPTED

Enum that identifies the HTTP/1.1 202 status code.

CarbonLDP.HTTP.StatusCode.NON_AUTHORITATIVE_INFORMATION

Enum that identifies the HTTP/1.1 203 status code.

CarbonLDP.HTTP.StatusCode.NO_CONTENT

Enum that identifies the HTTP/1.1 204 status code.

CarbonLDP.HTTP.StatusCode.RESET_CONTENT

Enum that identifies the HTTP/1.1 205 status code.

CarbonLDP.HTTP.StatusCode.PARTIAL_CONTENT

Enum that identifies the HTTP/1.1 206 status code.

CarbonLDP.HTTP.StatusCode.MULTIPLE_CHOICES

Enum that identifies the HTTP/1.1 300 status code.

CarbonLDP.HTTP.StatusCode.MOVED_PERMANENTLY

Enum that identifies the HTTP/1.1 301 status code.

CarbonLDP.HTTP.StatusCode.FOUND

Enum that identifies the HTTP/1.1 302 status code.

CarbonLDP.HTTP.StatusCode.SEE_OTHER

Enum that identifies the HTTP/1.1 303 status code.

CarbonLDP.HTTP.StatusCode.NOT_MODIFIED

Enum that identifies the HTTP/1.1 304 status code.

CarbonLDP.HTTP.StatusCode.USE_PROXY

Enum that identifies the HTTP/1.1 305 status code.

CarbonLDP.HTTP.StatusCode.TEMPORARY_REDIRECT

Enum that identifies the HTTP/1.1 307 status code.

CarbonLDP.HTTP.StatusCode.BAD_REQUEST

Enum that identifies the HTTP/1.1 400 status code.

CarbonLDP.HTTP.StatusCode.UNAUTHORIZED

Enum that identifies the HTTP/1.1 401 status code.

CarbonLDP.HTTP.StatusCode.PAYMENT_REQUIRED

Enum that identifies the HTTP/1.1 402 status code.

CarbonLDP.HTTP.StatusCode.FORBIDDEN

Enum that identifies the HTTP/1.1 403 status code.

CarbonLDP.HTTP.StatusCode.NOT_FOUND

Enum that identifies the HTTP/1.1 404 status code.

CarbonLDP.HTTP.StatusCode.METHOD_NOT_ALLOWED

Enum that identifies the HTTP/1.1 405 status code.

CarbonLDP.HTTP.StatusCode.NOT_ACCEPTABLE

Enum that identifies the HTTP/1.1 406 status code.

CarbonLDP.HTTP.StatusCode.PROXY_AUTHENTICATION_REQUIRED

Enum that identifies the HTTP/1.1 407 status code.

CarbonLDP.HTTP.StatusCode.REQUEST_TIME_OUT

Enum that identifies the HTTP/1.1 408 status code.

CarbonLDP.HTTP.StatusCode.CONFLICT

Enum that identifies the HTTP/1.1 409 status code.

CarbonLDP.HTTP.StatusCode.GONE

Enum that identifies the HTTP/1.1 410 status code.

CarbonLDP.HTTP.StatusCode.LENGTH_REQUIRED

Enum that identifies the HTTP/1.1 411 status code.

CarbonLDP.HTTP.StatusCode.PRECONDITION_FAILED

Enum that identifies the HTTP/1.1 412 status code.

CarbonLDP.HTTP.StatusCode.REQUEST_ENTITY_TOO_LARGE

Enum that identifies the HTTP/1.1 413 status code.

CarbonLDP.HTTP.StatusCode.REQUEST_URI_TOO_LARGE

Enum that identifies the HTTP/1.1 414 status code.

CarbonLDP.HTTP.StatusCode.UNSUPPORTED_MEDIA_TYPE

Enum that identifies the HTTP/1.1 415 status code.

CarbonLDP.HTTP.StatusCode.REQUESTED_RANGE_NOT_SATISFIABLE

Enum that identifies the HTTP/1.1 416 status code.

CarbonLDP.HTTP.StatusCode.EXPECTATION_FAILED

Enum that identifies the HTTP/1.1 417 status code.

CarbonLDP.HTTP.StatusCode.INTERNAL_SERVER_ERROR

Enum that identifies the HTTP/1.1 500 status code.

CarbonLDP.HTTP.StatusCode.NOT_IMPLEMENTED

Enum that identifies the HTTP/1.1 501 status code.

CarbonLDP.HTTP.StatusCode.BAD_GATEWAY

Enum that identifies the HTTP/1.1 502 status code.

CarbonLDP.HTTP.StatusCode.SERVICE_UNAVAILABLE

Enum that identifies the HTTP/1.1 503 status code.

CarbonLDP.HTTP.StatusCode.GATEWAY_TIME_OUT

Enum that identifies the HTTP/1.1 504 status code.

CarbonLDP.HTTP.StatusCode.HTTP_VERSION_NOT_SUPPORTED

Enum that identifies the HTTP/1.1 505 status code.







Implements:

Parses the body of a CarbonLDP.HTTP.Response and returns a string.


Methods

.parse()
: Promise<string>


parse( body:string ):Promise<string>

Gets a string and returns a Promise with the same string.


Param Type Default Description
body string







Classes

C
CarbonLDP.JSONLD.JSONLDConverter
Class that have methods for convert expanded JSON-LD objects to compacted Carbon SDK Resources and vice versa.




Class that have methods for convert expanded JSON-LD objects to compacted Carbon SDK Resources and vice versa.


Constructor


JSONLDConverter( literalSerializers?:Map<string, CarbonLDP.RDF.Literal.Serializer> )

Param Type Default Description
literalSerializers Map<string, CarbonLDP.RDF.Literal.Serializer>

A Map object with the data type serializers that the converter will only be able to handle.


Properties

.literalSerializers
: Map<string, CarbonLDP.RDF.Literal.Serializer>

A Map object with data-type/serializer pairs for stringify the data of a SDK Resource when expanding it.


Methods

.compact()
: Object


compact( expandedObject:Object, targetObject:Object, digestedSchema:CarbonLDP.DigestedObjectSchema, pointerLibrary:CarbonLDP.PointerLibrary ):Object

Assign the data of the expanded JSON-LD object, to the target object in a friendly mode, ie. without the JSON-LD Syntax Tokens and parsed values, in accordance to the schema provided.


Param Type Default Description
expandedObject Object

The JSON-LD object to compact.

targetObject Object

The target object where will be added the data of the expanded object.

digestedSchema CarbonLDP.DigestedObjectSchema

The schema that describes how compact the expanded object.

pointerLibrary CarbonLDP.PointerLibrary

An object from where one can obtain pointers to SDK Resources.



.expand()
: Object


expand( compactedObject:Object, digestedSchema:CarbonLDP.DigestedObjectSchema ):Object

Creates a expanded JSON-LD object from the compacted object in accordance to the schema provided.


Param Type Default Description
compactedObject Object

The compacted object to generate its expanded JSON-LD object.

digestedSchema CarbonLDP.DigestedObjectSchema

The schema that describes how construct the expanded object.





Classes

C
CarbonLDP.JSONLD.JSONLDParser
Class to parse strings to valid JSONLD objects.




Implements:

Class to parse strings to valid JSONLD objects.


Methods

.parse()
: Promise<object[]>


parse( body:string ):Promise<object[]>

Parse the string provided using the CarbonLDP.JSONLD.JSONLDProcessor#expand() method.


Param Type Default Description
body string

A JSON-LD string to parse.





Classes

C
CarbonLDP.JSONLD.JSONLDProcessor
Class that contains methods that can process JSON-LD objects.




Class that contains methods that can process JSON-LD objects.


Methods

#expand()
: Promise<object[]>


expand( input:object ):Promise<object[]>

Static method that expand a compacted JSON-LD object.


Param Type Default Description
input object

The compacted JSON-LD object to expand.





Classes

C
CarbonLDP.JSONLD.QueryResultCompacter
Class for compacting a set of RDF resources in level of relations




Class for compacting a set of RDF resources in level of relations


Constructor


QueryResultCompacter( registry:CarbonLDP.Registry<CarbonLDP.Document, any>, queryContainer:CarbonLDP.QueryDocuments.QueryContainer ):void

Param Type Default Description
registry CarbonLDP.Registry<CarbonLDP.Document, any>
queryContainer CarbonLDP.QueryDocuments.QueryContainer

Methods

.compactDocuments()
: (T & CarbonLDP.Document)[]


compactDocuments<T extends object>( rdfDocuments:CarbonLDP.RDF.RDFDocument[], targetDocuments:string[] ):(T & CarbonLDP.Document)[]

Param Type Default Description
rdfDocuments CarbonLDP.RDF.RDFDocument[]
targetDocuments string[]










Interface that represents an ldp:DirectContainer.


Properties

.hasMembershipRelation
: CarbonLDP.Pointer

Pointer that reference to the property the direct container manages.


.membershipResource
: CarbonLDP.Pointer

Pointer that references the document that the direct container belongs to.





Interface with the factory, decorate and utils methods of a CarbonLDP.LDP.TransientDirectContainer


Properties

Methods

.create()
: T & CarbonLDP.LDP.TransientDirectContainer


create<T extends object>( data:T & carbonLDP.LDP.BaseDirectContainer ):T & CarbonLDP.LDP.TransientDirectContainer

Creates a CarbonLDP.LDP.TransientDirectContainer object with the parameters specified.


Param Type Default Description
data T & carbonLDP.LDP.BaseDirectContainer

Data for creating a direct container.



.createFrom()
: T & CarbonLDP.LDP.TransientDirectContainer


createFrom<T extends object>( object:T & CarbonLDP.LDP.BaseDirectContainer ):T & CarbonLDP.LDP.TransientDirectContainer

Creates a CarbonLDP.LDP.TransientDirectContainer object with the object provided and the parameters specified.


Param Type Default Description
object T & CarbonLDP.LDP.BaseDirectContainer

Object to be converted into a direct container.



.is()
: value is CarbonLDP.LDP.TransientDirectContainer


is( value:any ):value is CarbonLDP.LDP.TransientDirectContainer

Returns true if the object provided is considered a CarbonLDP.LDP.TransientDirectContainer object.


Param Type Default Description
value any




Interfaces

I
CarbonLDP.LDP.DocumentMetadata
Interface that represents a free node resource that contains dynamic information about an specific resource.
I
CarbonLDP.LDP.DocumentMetadataFactory
Interface with the factory, decorate and utils methods for CarbonLDP.LDP.DocumentMetadata objects.

Properties




Interface that represents a free node resource that contains dynamic information about an specific resource.


Properties

.bNodesMap
: CarbonLDP.LDP.Map<CarbonLDP.Pointer, CarbonLDP.Pointer>

A c:Map object that contains the changes of persisted BNode IDs.


.relatedDocument
: CarbonLDP.Pointer

Reference to the resource the metadata information refers to.





Interface with the factory, decorate and utils methods for CarbonLDP.LDP.DocumentMetadata objects.


Properties




Interfaces

I
CarbonLDP.LDP.Error
Interface that represents an error occurred in the server.
I
CarbonLDP.LDP.ErrorFactory
Interface with the factory, decorate and utils function for CarbonLDP.LDP.Error objects.

Properties




Interface that represents an error occurred in the server.


Properties

.errorCode
: string

An specific code that indicates the type of error the current object is.


.errorMessage
: string

Message that explains the error occurred in the server.


.errorParameters
: CarbonLDP.LDP.Map<string, any>

Map that contains the specific elements that make the error been thrown.





Interface with the factory, decorate and utils function for CarbonLDP.LDP.Error objects.


Properties




Classes

C
CarbonLDP.LDP.ErrorResponseFactory
Useful functions for managing CarbonLDP.LDP.ErrorResponse objects.

Interfaces

I
CarbonLDP.LDP.ErrorResponse
Interface that its used to represents part of an error (or multiple of them) thrown by the server.
I
CarbonLDP.LDP.ErrorResponseFactory
Interface with the factory, decorate and utils methods for CarbonLDP.LDP.ErrorResponse objects.




Interface that its used to represents part of an error (or multiple of them) thrown by the server.


Properties

.errors
: CarbonLDP.LDP.Error[]

Array that list the error occurred in the server.


.requestID
: string

An ID that identifies the request which cause the error.


.statusCode
: number

The HTTP status code that represents all the errors occurred.





Interface with the factory, decorate and utils methods for CarbonLDP.LDP.ErrorResponse objects.


Properties

Methods

.getMessage()
: string


getMessage( errorResponse:CarbonLDP.LDP.ErrorResponse ):string

Returns a string with the message of all the errors in the ErrorResponse.


Param Type Default Description
errorResponse CarbonLDP.LDP.ErrorResponse

The ErrorResponse object to obtain the message from.





Useful functions for managing CarbonLDP.LDP.ErrorResponse objects.





Interfaces

I
CarbonLDP.LDP.Map
Interface that contains a set entries with a close relation in the form of a key/value pair.
I
CarbonLDP.LDP.MapFactory
Interface with the factory, decorate and utils methods for CarbonLDP.LDP.Map objects.

Properties




CarbonLDP.LDP.Map
Interface

Interface that contains a set entries with a close relation in the form of a key/value pair.


Properties

.entries
: CarbonLDP.LDP.MapEntry<K,V>[]

An array of entries' pair relations.





Interface with the factory, decorate and utils methods for CarbonLDP.LDP.Map objects.


Properties

Methods

.is()
: object is CarbonLDP.LDP.Map<any, any>


is( object:object ):object is CarbonLDP.LDP.Map<any, any>

Return true if the object provided is considered a CarbonLDP.LDP.Map object.


Param Type Default Description
object object

Object to check





Interfaces

I
CarbonLDP.LDP.MapEntry
Entries of the CarbonLDP.LDP.Map with the key/value pair.
I
CarbonLDP.LDP.MapEntryFactory
Interface with the factory, decorate and utils methods for CarbonLDP.LDP.MapEntry objects

Properties




Entries of the CarbonLDP.LDP.Map with the key/value pair.


Properties

.entryKey
: K

The key element of the entry's pair.


.entryValue
: V

The value element of the entry's pair.





Interface with the factory, decorate and utils methods for CarbonLDP.LDP.MapEntry objects


Properties




Interfaces

I
CarbonLDP.LDP.ResponseMetadata
Interface that represents the main resource of a set of metadata resources, which references everyone resource related to an specific dynamic response of tha server.
I
CarbonLDP.LDP.ResponseMetadataFactory
Interface with the factory, decorate and utils methods for CarbonLDP.LDP.ResponseMetadata objects.

Properties




Interface that represents the main resource of a set of metadata resources, which references everyone resource related to an specific dynamic response of tha server.


Properties

.documentsMetadata
: CarbonLDP.LDP.DocumentMetadata[]

An array with all the metadata resources of the dynamic response.





Interface with the factory, decorate and utils methods for CarbonLDP.LDP.ResponseMetadata objects.


Properties

Methods

.is()
: object is CarbonLDP.LDP.ResponseMetadata


is( object:object ):object is CarbonLDP.LDP.ResponseMetadata

Return true if the object provided is considered a CarbonLDP.LDP.ResponseMetadata object.


Param Type Default Description
object object

Object to check





Interfaces

I
CarbonLDP.LDP.ValidationError
Interface that contains the properties that describe how the validation failed.
I
CarbonLDP.LDP.ValidationErrorFactory
Interface with the factory, decorate and utils methods for CarbonLDP.LDP.ValidationError objects.

Properties




Interface that contains the properties that describe how the validation failed.


Properties

.errorDetails
: CarbonLDP.Pointer

Pointer with the error details of how the validation failed.





Interface with the factory, decorate and utils methods for CarbonLDP.LDP.ValidationError objects.


Properties




Interfaces

I
CarbonLDP.LDP.VolatileResource
Interface that represents a free resource, i.e. a dynamic generated resource that does not have a persisted form.
I
CarbonLDP.LDP.VolatileResourceFactory
Interface with the factory, decorate an utils methods for CarbonLDP.LDP.VolatileResource objects.

Properties




Interface that represents a free resource, i.e. a dynamic generated resource that does not have a persisted form.





Interface with the factory, decorate an utils methods for CarbonLDP.LDP.VolatileResource objects.


Properties

.TYPE
: string


Methods

.create()
: void


create():void



.createFrom()
: void


createFrom():void



.is()
: void


is():void











Creator of LDPatch deltas


Constructor


DeltaCreator( context:CarbonLDP.Context ):void

Param Type Default Description
context CarbonLDP.Context

Methods

.addResource()
: void


addResource( schema:CarbonLDP.DigestedObjectSchema, previousResource:CarbonLDP.TransientResource, currentResource:CarbonLDP.TransientResource ):void

Creates and adds the delta to the patch, of the provided old and new resource.


Param Type Default Description
schema CarbonLDP.DigestedObjectSchema

The schema of the resource to create its delta.

previousResource CarbonLDP.TransientResource

The old representation of the resource to create the delta.

currentResource CarbonLDP.TransientResource

The current representation of the resource to create the delta.



.getPatch()
: string


getPatch():string

Returns the LD Patch string of the resources provided in addResource method.






Classes

C
CarbonLDP.LDPatch.AddToken
LD Patch add action.
C
CarbonLDP.LDPatch.DeleteToken
LD Patch delete action.
C
CarbonLDP.LDPatch.LDPatchToken
An LD Patch expression.
C
CarbonLDP.LDPatch.PrefixToken
LD Patch add action.
C
CarbonLDP.LDPatch.SliceToken
LD Patch list slice expression token.
C
CarbonLDP.LDPatch.UpdateListToken
LD Patch update list action.




Implements:
sparqler/tokens/TokenNode

LD Patch add action.


Constructor


AddToken():void


Properties

.token
: add


.triples
: sparqler/tokens/SubjectToken[]


Methods




Implements:
sparqler/tokens/TokenNode

LD Patch delete action.


Constructor


DeleteToken():void


Properties

.token
: delete


.triples
: sparqler/tokens/SubjectToken[]


Methods







Implements:
sparqler/tokens/TokenNode

LD Patch add action.


Constructor


PrefixToken( namespace:string, iri:sparqler/tokens/IRIRefToken ):void

Param Type Default Description
namespace string

The namespace of the LD Patch prefix.

iri sparqler/tokens/IRIRefToken

The IRI of the LD Patch prefix.


Properties

.iri
: sparqler/tokens/IRIRefToken


.namespace
: string


.token
: prefix


Methods




Implements:
sparqler/tokens/TokenNode

LD Patch list slice expression token.


Constructor


SliceToken( minIndex?:number, maxIndex?:number ):void

Param Type Default Description
minIndex number

The minimum index of the list's range to update.

maxIndex number

The maximum index of the list's range to update.


Properties

.maxIndex
: number


.minIndex
: number


.token
: slice


Methods




Implements:
sparqler/tokens/TokenNode

LD Patch update list action.


Constructor


UpdateListToken( subject:sparqler/tokens/VariableORIRI | sparqler/tokens/BlankNodeToken, predicate:sparqler/tokens/IRIRefToken | sparqler/tokens/PrefixedNameToken, slice:CarbonLDP.LDPatch.SliceToken, collection:sparqler/tokens/CollectionToken ):void

Param Type Default Description
subject sparqler/tokens/VariableORIRI | sparqler/tokens/BlankNodeToken

The subject that contains the list to update.

predicate sparqler/tokens/IRIRefToken | sparqler/tokens/PrefixedNameToken

The predicate relation to the list to update.

slice CarbonLDP.LDPatch.SliceToken

The slice that specifies the index of the elements in the list that will be replaced.

collection sparqler/tokens/CollectionToken

The collection to replace the selected elements by the slice token.


Properties

.collection
: sparqler/tokens/CollectionToken


.predicate
: sparqler/tokens/IRIRefToken | sparqler/tokens/PrefixedNameToken


.slice
: CarbonLDP.LDPatch.SliceToken


.subject
: sparqler/tokens/VariableORIRI | sparqler/tokens/BlankNodeToken


.token
: updateList


Methods




Interfaces

I
CarbonLDP.Members.AddMemberAction
Interface that represents an object to be sent in a request that add members to a container.
I
CarbonLDP.Members.AddMemberActionFactory
Interface with the factory, decorate and utils methods of CarbonLDP.Members.AddMemberAction objects
I
CarbonLDP.Members.BaseAddMemberAction
Interface that represents an object to be sent in a request that add members to a container.

Properties




Interface that represents an object to be sent in a request that add members to a container.


Properties

.targetMembers
: CarbonLDP.Pointer[]

Array with the members to be added to the container.





Interface with the factory, decorate and utils methods of CarbonLDP.Members.AddMemberAction objects


Properties

Methods

.create()
: CarbonLDP.Members.AddMemberAction


create<T extends object>( data:T & CarbonLDP.Members.BaseAddMemberAction ):CarbonLDP.Members.AddMemberAction

Creates CarbonLDP.Members.AddMemberAction resource for the specified targetMembers.


Param Type Default Description
data T & CarbonLDP.Members.BaseAddMemberAction

Data to be used in the creation of an add member action.



.createFrom()
: CarbonLDP.Members.AddMemberAction


createFrom<T extends object>( object:T & CarbonLDP.Members.BaseAddMemberAction ):CarbonLDP.Members.AddMemberAction

Creates CarbonLDP.Members.AddMemberAction resource for the specified targetMembers.


Param Type Default Description
object T & CarbonLDP.Members.BaseAddMemberAction

Object to be converted into an add member action.



.is()
: value is CarbonLDP.Members.AddMemberAction


is( value:any ):value is CarbonLDP.Members.AddMemberAction

Returns true if the object is considered a CarbonLDP.Members.AddMemberAction object.


Param Type Default Description
value any




Interface that represents an object to be sent in a request that add members to a container.


Properties

.targetMembers
: CarbonLDP.Pointer[]

The target members to add in a addMember request.





Interfaces

I
CarbonLDP.Members.BaseRemoveMemberAction
Interface that represents an object to be sent in a request that add members to a container.
I
CarbonLDP.Members.RemoveMemberAction
Interface that represents an object to be sent in a request that removes specific members to a container.
I
CarbonLDP.Members.RemoveMemberActionFactory
Interface with the factory, decorate and utils methods for CarbonLDP.Members.RemoveMemberAction

Properties




Interface that represents an object to be sent in a request that add members to a container.


Properties

.targetMembers
: CarbonLDP.Pointer[]

The target members to remove in a removeMember request.





Interface that represents an object to be sent in a request that removes specific members to a container.


Properties

.targetMembers
: CarbonLDP.Pointer[]

Array with the members to be removed from the container.





Interface with the factory, decorate and utils methods for CarbonLDP.Members.RemoveMemberAction


Properties

Methods

.create()
: CarbonLDP.Members.RemoveMemberAction


create<T extends object>( data:T & CarbonLDP.Members.BaseRemoveMemberAction ):CarbonLDP.Members.RemoveMemberAction

Creates CarbonLDP.Members.RemoveMemberAction resource for the specified targetMembers.


Param Type Default Description
data T & CarbonLDP.Members.BaseRemoveMemberAction

Data to be used in the creation of an remove member action.



.createFrom()
: CarbonLDP.Members.RemoveMemberAction


createFrom<T extends object>( object:T & CarbonLDP.Members.BaseRemoveMemberAction ):CarbonLDP.Members.RemoveMemberAction

Creates CarbonLDP.Members.RemoveMemberAction resource for the specified targetMembers.


Param Type Default Description
object T & CarbonLDP.Members.BaseRemoveMemberAction

Object to be converted into an remove member action.



.is()
: value is CarbonLDP.Members.RemoveMemberAction


is( value:any ):value is CarbonLDP.Members.RemoveMemberAction

Returns true if the object is considered a CarbonLDP.Members.RemoveMemberAction object.


Param Type Default Description
value any




Reexports





Interfaces

I
CarbonLDP.Messaging.ChildCreatedEvent
Interface with the base properties of the data received in any document created event.
I
CarbonLDP.Messaging.ChildCreatedEventFactory
Interface with the factory, decorate and utils for CarbonLDP.Messaging.ChildCreatedEvent objects.

Properties




Interface with the base properties of the data received in any document created event.


Properties










Interface with the properties of the details in a document created event.


Properties










Interface with the properties of the data received in a document deleted event.


Properties




Interface with the factory, decorate and utils for CarbonLDP.Messaging.DocumentDeletedEvent objects.


Properties







Interface with the properties of the data received in a document modified event.


Properties







.Event
: enum

Enumeration Description
CarbonLDP.Messaging.Event.CHILD_CREATED
CarbonLDP.Messaging.Event.DOCUMENT_MODIFIED
CarbonLDP.Messaging.Event.DOCUMENT_DELETED
CarbonLDP.Messaging.Event.MEMBER_ADDED
CarbonLDP.Messaging.Event.MEMBER_REMOVED



Interfaces

I
CarbonLDP.Messaging.EventMessage
Interface with the base properties of the data received in a subscription event.
I
CarbonLDP.Messaging.EventMessageFactory
Interface with the factory, decorate and utils elements for CarbonLDP.Messaging.EventMessage objects.

Properties




Interface with the base properties of the data received in a subscription event.


Properties




Interface with the factory, decorate and utils elements for CarbonLDP.Messaging.EventMessage objects.


Properties

Methods

.is()
: value is CarbonLDP.Messaging.EventMessage


is( value:any ):value is CarbonLDP.Messaging.EventMessage

Returns true if the object is considered a CarbonLDP.Messaging.EventMessage interface.


Param Type Default Description
value any

The value to be tested.

















Interface with the properties of the details in a member added event.


Properties




Interface with the factory, decorator and utils for CarbonLDP.Messaging.MemberAddedEventDetails objects.


Properties







Interface with the base properties of the details in a member related event.


Properties
















Interfaces

I
CarbonLDP.Messaging.MemberRemovedEventDetails
Interface with the properties of the details in a member removed event.
I

P