Class ListsEndpointAdmin

An endpoint for working with Knora lists.

Hierarchy

Endpoint
- ListsEndpointAdmin

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Methods

Constructors

constructor

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

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

Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
Returns ListsEndpointAdmin

Properties

jsonConvert

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

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

Protected path

path: string

Accessors

jsonWebToken

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

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

Returns string
Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:48
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:143
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:56
Creates a list.

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

getList

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

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:70
Gets a list.

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

getListInfo

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

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

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

getListNodeInfo

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

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

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

getLists

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

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:28
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:42
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:150
Handles parsing errors.

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

Protected httpDelete

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

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

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpGet

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

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

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpPatch

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

Inherited from Endpoint.httpPatch
- Defined in src/api/endpoint.ts:125
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.
Returns Observable<AjaxResponse>

Protected httpPost

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

Inherited from Endpoint.httpPost
- Defined in src/api/endpoint.ts:95
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.
Returns Observable<AjaxResponse>

Protected httpPut

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

Inherited from Endpoint.httpPut
- Defined in src/api/endpoint.ts:110
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.
Returns Observable<AjaxResponse>

updateChildComments

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

- Defined in src/api/admin/lists/lists-endpoint-admin.ts:129
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:114
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:99
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>

updateListInfo

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

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

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

Generated using TypeDoc