ListsEndpointAdmin | @dasch-swiss/dsp-js API Documentation

An endpoint for working with Knora lists.

Hierarchy

Endpoint
- ListsEndpointAdmin

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Constructors

constructor

new ListsEndpointAdmin(knoraApiConfig: KnoraApiConfig, path: string): ListsEndpointAdmin

Inherited from Endpoint.constructor
- Defined in src/api/endpoint.ts:56
Constructor.

Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
Returns ListsEndpointAdmin

Properties

delay

delay: 500 = 500

jsonConvert

jsonConvert: JsonConvert = new JsonConvert(OperationMode.ENABLE,ValueCheckingMode.DISALLOW_NULL,false,PropertyMatchingRule.CASE_STRICT)

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

maxRetries

maxRetries: 5 = 5

Protected path

path: string

retryOnErrorStatus

retryOnErrorStatus: number[] = [0, 500]

Accessors

jsonWebToken

get jsonWebToken(): string
set jsonWebToken(value: string): void

Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:47
The session token

Returns string
Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:54
The session token

Parameters
- value: string
Returns void

Methods

createChildNode

createChildNode(node: CreateChildNodeRequest): Observable<ApiResponseData<ListNodeInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:122
Creates a child node in a list.

Parameters
- node: CreateChildNodeRequest
  
  The node to be created.
Returns Observable<ApiResponseData<ListNodeInfoResponse> | ApiResponseError>

createList

createList(listInfo: CreateListRequest): Observable<ApiResponseData<ListResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:223
Creates a list using the old route but with the feature toggle enabled.

Parameters
- listInfo: CreateListRequest
  
  Information about the list to be created.
Returns Observable<ApiResponseData<ListResponse> | ApiResponseError>

deleteListNode

deleteListNode(iri: string): Observable<ApiResponseData<DeleteListNodeResponse | DeleteListResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:151
Returns the parent node if an IRI of a child node is given. Returns a deleted flag and IRI if an IRI of a root node is given.

Parameters
- iri: string
  
  The IRI of the list.
Returns Observable<ApiResponseData<DeleteListNodeResponse | DeleteListResponse> | ApiResponseError>

getList

getList(listItemIri: string): Observable<ApiResponseData<ListResponse | ListChildNodeResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:237
Gets a list using the old route but with the feature toggle enabled

Parameters
- listItemIri: string
  
  The IRI of the list.
Returns Observable<ApiResponseData<ListResponse | ListChildNodeResponse> | ApiResponseError>

getListInfo

getListInfo(iri: string): Observable<ApiResponseData<ListInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:136
Returns information about a list.

Parameters
- iri: string
  
  The IRI of the list.
Returns Observable<ApiResponseData<ListInfoResponse> | ApiResponseError>

getListNodeInfo

getListNodeInfo(listItemIri: string): Observable<ApiResponseData<ListNodeInfoResponse | ListInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:203
Returns information about a list node using the new route.

Parameters
- listItemIri: string
  
  The IRI of the node.
Returns Observable<ApiResponseData<ListNodeInfoResponse | ListInfoResponse> | ApiResponseError>

getLists

getLists(): Observable<ApiResponseData<ListsResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:35
Returns a list of lists.

Returns Observable<ApiResponseData<ListsResponse> | ApiResponseError>

getListsInProject

getListsInProject(projectIri: string): Observable<ApiResponseData<ListsResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:49
Returns a list of lists in a project.

Parameters
- projectIri: string
  
  The IRI of the project.
Returns Observable<ApiResponseData<ListsResponse> | ApiResponseError>

Protected handleError

handleError(error: AjaxError | DataError): Observable<ApiResponseError>

Inherited from Endpoint.handleError
- Defined in src/api/endpoint.ts:159
Handles parsing errors.

Parameters
- error: AjaxError | DataError
  
  the error class provided by us
Returns Observable<ApiResponseError>

Protected httpDelete

httpDelete(path?: undefined | string, headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpDelete
- Defined in src/api/endpoint.ts:144
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpGet

httpGet(path?: undefined | string, headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpGet
- Defined in src/api/endpoint.ts:70
Performs a general GET request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpPatch

httpPatch(path?: undefined | string, body?: any, contentType?: "json", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpPatch
- Defined in src/api/endpoint.ts:127
Performs a general PATCH request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpPost

httpPost(path?: undefined | string, body?: any, contentType?: "json" | "sparql", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpPost
- Defined in src/api/endpoint.ts:89
Performs a general POST request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request, if any.
- Default value contentType: "json" | "sparql" = "json"
  
  content content type of body, if any.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

Protected httpPut

httpPut(path?: undefined | string, body?: any, contentType?: "json", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

Inherited from Endpoint.httpPut
- Defined in src/api/endpoint.ts:108
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
- Optional headerOpts: IHeaderOptions
  
  additional headers, if any.
Returns Observable<AjaxResponse>

repositionChildNode

repositionChildNode(iri: string, repositionRequest: RepositionChildNodeRequest): Observable<ApiResponseData<RepositionChildNodeResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:171
Move child node to a certain position in a list. Parent node IRI can be the same but only if the position is different.

Parameters
- iri: string
  
  The IRI of the list node to move.
- repositionRequest: RepositionChildNodeRequest
  
  The parent node IRI and the position the child node should move to.
Returns Observable<ApiResponseData<RepositionChildNodeResponse> | ApiResponseError>

updateChildComments

updateChildComments(listItemIri: string, comments: UpdateChildNodeCommentsRequest): Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:108
Updates the comments of an existing child node.

Parameters
- listItemIri: string
  
  the Iri of the list item.
- comments: UpdateChildNodeCommentsRequest
  
  the new comments to replace the existing comments.
Returns Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

updateChildLabels

updateChildLabels(listItemIri: string, labels: UpdateChildNodeLabelsRequest): Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:93
Updates the labels of an existing child node.

Parameters
- listItemIri: string
  
  the Iri of the list item.
- labels: UpdateChildNodeLabelsRequest
  
  the new labels to replace the existing labels.
Returns Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

updateChildName

updateChildName(listItemIri: string, name: UpdateChildNodeNameRequest): Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:78
Updates the name of an existing child node.

Parameters
- listItemIri: string
  
  the Iri of the list item.
- name: UpdateChildNodeNameRequest
  
  the new name to replace the existing name.
Returns Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

updateChildNode

updateChildNode(nodeInfo: UpdateChildNodeRequest): Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:185
Updates a child node.

Parameters
- nodeInfo: UpdateChildNodeRequest
  
  Information about the node to be updated.
Returns Observable<ApiResponseData<ChildNodeInfoResponse> | ApiResponseError>

updateListInfo

updateListInfo(listInfo: UpdateListInfoRequest): Observable<ApiResponseData<ListInfoResponse> | ApiResponseError>

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:63
Updates information about a list.

Parameters
- listInfo: UpdateListInfoRequest
  
  Information about the list to be created.
Returns Observable<ApiResponseData<ListInfoResponse> | ApiResponseError>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

knoraApiConfig: KnoraApiConfig

path: string

Returns ListsEndpointAdmin

Properties

delay

jsonConvert

Protected knoraApiConfig

maxRetries

Protected path

retryOnErrorStatus

Accessors

jsonWebToken

Returns string

Parameters

value: string

Returns void

Methods

createChildNode

Parameters

node: CreateChildNodeRequest

Returns Observable<ApiResponseData<ListNodeInfoResponse> | ApiResponseError>

createList

Parameters

listInfo: CreateListRequest

Returns Observable<ApiResponseData<ListResponse> | ApiResponseError>

deleteListNode

Parameters

iri: string

Returns Observable<ApiResponseData<DeleteListNodeResponse | DeleteListResponse> | ApiResponseError>

getList

Parameters

listItemIri: string

Returns Observable<ApiResponseData<ListResponse | ListChildNodeResponse> | ApiResponseError>

getListInfo

Parameters

iri: string

Returns Observable<ApiResponseData<ListInfoResponse> | ApiResponseError>

getListNodeInfo

Parameters

listItemIri: string

Returns Observable<ApiResponseData<ListNodeInfoResponse | ListInfoResponse> | ApiResponseError>

getLists

Returns Observable<ApiResponseData<ListsResponse> | ApiResponseError>

getListsInProject

Parameters

projectIri: string

Returns Observable<ApiResponseData<ListsResponse> | ApiResponseError>

Protected handleError

Parameters

error: AjaxError | DataError

Returns Observable<ApiResponseError>

Protected httpDelete

Parameters

Optional path: undefined | string

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpGet

Parameters

Optional path: undefined | string

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpPatch

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpPost

Parameters

Optional path: undefined | string